diff --git a/Auth0.podspec b/Auth0.podspec index ce0c435a..068de820 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.6.0' + s.version = '2.7.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 84df3cc2..febd1af6 100644 --- a/Auth0/Info.plist +++ b/Auth0/Info.plist @@ -15,7 +15,7 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 2.6.0 + 2.7.0 CFBundleSignature ???? CFBundleVersion diff --git a/Auth0/Version.swift b/Auth0/Version.swift index 05433ec5..c8b936b0 100644 --- a/Auth0/Version.swift +++ b/Auth0/Version.swift @@ -1 +1 @@ -let version = "2.6.0" +let version = "2.7.0" diff --git a/CHANGELOG.md b/CHANGELOG.md index c8f8c955..8515df80 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [2.7.0](https://github.com/auth0/Auth0.swift/tree/2.7.0) (2024-04-12) +[Full Changelog](https://github.com/auth0/Auth0.swift/compare/2.6.0...2.7.0) + +**Added** +- chore: Add privacy manifest to Auth0.Swift [\#841](https://github.com/auth0/Auth0.swift/pull/841) ([poovamraj](https://github.com/poovamraj)) + ## [2.6.0](https://github.com/auth0/Auth0.swift/tree/2.6.0) (2024-03-01) [Full Changelog](https://github.com/auth0/Auth0.swift/compare/2.5.0...2.6.0) diff --git a/Gemfile.lock b/Gemfile.lock index d99fbdae..b5281760 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,45 +1,54 @@ GEM remote: https://rubygems.org/ specs: - CFPropertyList (3.0.6) + CFPropertyList (3.0.7) + base64 + nkf rexml - activesupport (7.0.8) + activesupport (7.1.3.2) + base64 + bigdecimal concurrent-ruby (~> 1.0, >= 1.0.2) + connection_pool (>= 2.2.5) + drb i18n (>= 1.6, < 2) minitest (>= 5.1) + mutex_m tzinfo (~> 2.0) - addressable (2.8.5) + addressable (2.8.6) public_suffix (>= 2.0.2, < 6.0) algoliasearch (1.27.5) httpclient (~> 2.8, >= 2.8.3) json (>= 1.5.1) - artifactory (3.0.15) + artifactory (3.0.17) atomos (0.1.3) - aws-eventstream (1.2.0) - aws-partitions (1.831.0) - aws-sdk-core (3.185.0) - aws-eventstream (~> 1, >= 1.0.2) + aws-eventstream (1.3.0) + aws-partitions (1.913.0) + aws-sdk-core (3.191.6) + aws-eventstream (~> 1, >= 1.3.0) aws-partitions (~> 1, >= 1.651.0) - aws-sigv4 (~> 1.5) + aws-sigv4 (~> 1.8) jmespath (~> 1, >= 1.6.1) - aws-sdk-kms (1.72.0) - aws-sdk-core (~> 3, >= 3.184.0) + aws-sdk-kms (1.78.0) + aws-sdk-core (~> 3, >= 3.191.0) aws-sigv4 (~> 1.1) - aws-sdk-s3 (1.136.0) - aws-sdk-core (~> 3, >= 3.181.0) + aws-sdk-s3 (1.146.1) + aws-sdk-core (~> 3, >= 3.191.0) aws-sdk-kms (~> 1) - aws-sigv4 (~> 1.6) - aws-sigv4 (1.6.0) + aws-sigv4 (~> 1.8) + aws-sigv4 (1.8.0) aws-eventstream (~> 1, >= 1.0.2) babosa (1.0.4) + base64 (0.2.0) + bigdecimal (3.1.7) claide (1.1.0) clamp (1.3.2) - cocoapods (1.13.0) + cocoapods (1.15.2) addressable (~> 2.8) claide (>= 1.0.2, < 2.0) - cocoapods-core (= 1.13.0) + cocoapods-core (= 1.15.2) cocoapods-deintegrate (>= 1.0.3, < 2.0) - cocoapods-downloader (>= 1.6.0, < 2.0) + cocoapods-downloader (>= 2.1, < 3.0) cocoapods-plugins (>= 1.0.0, < 2.0) cocoapods-search (>= 1.0.0, < 2.0) cocoapods-trunk (>= 1.6.0, < 2.0) @@ -52,7 +61,7 @@ GEM nap (~> 1.0) ruby-macho (>= 2.3.0, < 3.0) xcodeproj (>= 1.23.0, < 2.0) - cocoapods-core (1.13.0) + cocoapods-core (1.15.2) activesupport (>= 5.0, < 8) addressable (~> 2.8) algoliasearch (~> 1.0) @@ -63,7 +72,7 @@ GEM public_suffix (~> 4.0) typhoeus (~> 1.0) cocoapods-deintegrate (1.0.5) - cocoapods-downloader (1.6.3) + cocoapods-downloader (2.1) cocoapods-plugins (1.0.0) nap cocoapods-search (1.0.1) @@ -75,18 +84,19 @@ GEM colored2 (3.1.2) commander (4.6.0) highline (~> 2.0.0) - concurrent-ruby (1.2.2) + concurrent-ruby (1.2.3) + connection_pool (2.4.1) declarative (0.0.20) digest-crc (0.6.5) rake (>= 12.0.0, < 14.0.0) - domain_name (0.5.20190701) - unf (>= 0.0.5, < 1.0.0) + domain_name (0.6.20240107) dotenv (2.8.1) + drb (2.2.1) emoji_regex (3.2.3) escape (0.0.4) ethon (0.16.0) ffi (>= 1.15.0) - excon (0.104.0) + excon (0.110.0) faraday (1.10.3) faraday-em_http (~> 1.0) faraday-em_synchrony (~> 1.0) @@ -115,15 +125,15 @@ GEM faraday-retry (1.0.3) faraday_middleware (1.2.0) faraday (~> 1.0) - fastimage (2.2.7) - fastlane (2.216.0) + fastimage (2.3.1) + fastlane (2.220.0) CFPropertyList (>= 2.3, < 4.0.0) addressable (>= 2.8, < 3.0.0) artifactory (~> 3.0) aws-sdk-s3 (~> 1.0) babosa (>= 1.0.3, < 2.0.0) bundler (>= 1.12.0, < 3.0.0) - colored + colored (~> 1.2) commander (~> 4.6) dotenv (>= 2.1.1, < 3.0.0) emoji_regex (>= 0.1, < 4.0) @@ -135,6 +145,7 @@ GEM gh_inspector (>= 1.1.2, < 2.0.0) google-apis-androidpublisher_v3 (~> 0.3) google-apis-playcustomapp_v1 (~> 0.1) + google-cloud-env (>= 1.6.0, < 2.0.0) google-cloud-storage (~> 1.31) highline (~> 2.0) http-cookie (~> 1.0.5) @@ -143,10 +154,10 @@ GEM mini_magick (>= 4.9.4, < 5.0.0) multipart-post (>= 2.0.0, < 3.0.0) naturally (~> 2.2) - optparse (~> 0.1.1) + optparse (>= 0.1.1, < 1.0.0) plist (>= 3.1.0, < 4.0.0) rubyzip (>= 2.0.0, < 3.0.0) - security (= 0.1.3) + security (= 0.1.5) simctl (~> 1.6.3) terminal-notifier (>= 2.0.0, < 3.0.0) terminal-table (~> 3) @@ -155,16 +166,16 @@ GEM word_wrap (~> 1.0.0) xcodeproj (>= 1.13.0, < 2.0.0) xcpretty (~> 0.3.0) - xcpretty-travis-formatter (>= 0.0.3) + xcpretty-travis-formatter (>= 0.0.3, < 2.0.0) fastlane-plugin-auth0_shipper (0.4.1) semantic (~> 1.5) - ffi (1.16.2) + ffi (1.16.3) fourflusher (2.3.1) fuzzy_match (2.0.4) gh_inspector (1.1.3) - google-apis-androidpublisher_v3 (0.50.0) + google-apis-androidpublisher_v3 (0.54.0) google-apis-core (>= 0.11.0, < 2.a) - google-apis-core (0.11.1) + google-apis-core (0.11.3) addressable (~> 2.5, >= 2.5.1) googleauth (>= 0.16.2, < 2.a) httpclient (>= 2.8.1, < 3.a) @@ -172,24 +183,23 @@ GEM representable (~> 3.0) retriable (>= 2.0, < 4.a) rexml - webrick google-apis-iamcredentials_v1 (0.17.0) google-apis-core (>= 0.11.0, < 2.a) google-apis-playcustomapp_v1 (0.13.0) google-apis-core (>= 0.11.0, < 2.a) - google-apis-storage_v1 (0.19.0) - google-apis-core (>= 0.9.0, < 2.a) - google-cloud-core (1.6.0) - google-cloud-env (~> 1.0) + google-apis-storage_v1 (0.31.0) + google-apis-core (>= 0.11.0, < 2.a) + google-cloud-core (1.7.0) + google-cloud-env (>= 1.0, < 3.a) google-cloud-errors (~> 1.0) google-cloud-env (1.6.0) faraday (>= 0.17.3, < 3.0) - google-cloud-errors (1.3.1) - google-cloud-storage (1.44.0) + google-cloud-errors (1.4.0) + google-cloud-storage (1.47.0) addressable (~> 2.8) digest-crc (~> 0.4) google-apis-iamcredentials_v1 (~> 0.1) - google-apis-storage_v1 (~> 0.19.0) + google-apis-storage_v1 (~> 0.31.0) google-cloud-core (~> 1.6) googleauth (>= 0.16.2, < 2.a) mini_mime (~> 1.0) @@ -203,29 +213,34 @@ GEM http-cookie (1.0.5) domain_name (~> 0.5) httpclient (2.8.3) - i18n (1.14.1) + i18n (1.14.4) concurrent-ruby (~> 1.0) jmespath (1.6.2) - json (2.6.3) - jwt (2.7.1) + json (2.7.2) + jwt (2.8.1) + base64 mini_magick (4.12.0) mini_mime (1.1.5) - minitest (5.20.0) + minitest (5.22.3) molinillo (0.8.0) multi_json (1.15.0) - multipart-post (2.3.0) + multipart-post (2.4.0) + mutex_m (0.2.0) nanaimo (0.3.0) nap (1.1.0) naturally (2.2.1) netrc (0.11.0) - nokogiri (1.15.4-x86_64-darwin) + nkf (0.2.0) + nokogiri (1.16.4-arm64-darwin) + racc (~> 1.4) + nokogiri (1.16.4-x86_64-darwin) racc (~> 1.4) - optparse (0.1.1) + optparse (0.4.0) os (1.1.4) - plist (3.7.0) + plist (3.7.1) public_suffix (4.0.7) - racc (1.7.1) - rake (13.0.6) + racc (1.7.3) + rake (13.2.1) representable (3.2.0) declarative (< 0.1.0) trailblazer-option (>= 0.1.1, < 0.2.0) @@ -236,9 +251,9 @@ GEM ruby-macho (2.5.1) ruby2_keywords (0.0.5) rubyzip (2.3.2) - security (0.1.3) + security (0.1.5) semantic (1.6.1) - signet (0.18.0) + signet (0.19.0) addressable (~> 2.8) faraday (>= 0.17.5, < 3.a) jwt (>= 1.5, < 3.0) @@ -246,7 +261,7 @@ GEM simctl (1.6.10) CFPropertyList naturally - slather (2.7.5) + slather (2.8.0) CFPropertyList (>= 2.2, < 4) activesupport clamp (~> 1.3) @@ -257,21 +272,17 @@ GEM unicode-display_width (>= 1.1.1, < 3) trailblazer-option (0.1.2) tty-cursor (0.7.1) - tty-screen (0.8.1) + tty-screen (0.8.2) tty-spinner (0.9.3) tty-cursor (~> 0.7) - typhoeus (1.4.0) + typhoeus (1.4.1) ethon (>= 0.9.0) tzinfo (2.0.6) concurrent-ruby (~> 1.0) uber (0.1.0) - unf (0.1.4) - unf_ext - unf_ext (0.0.8.2) unicode-display_width (2.5.0) - webrick (1.8.1) word_wrap (1.0.0) - xcodeproj (1.23.0) + xcodeproj (1.24.0) CFPropertyList (>= 2.3.3, < 4.0) atomos (~> 0.1.3) claide (>= 1.0.2, < 2.0) @@ -284,7 +295,8 @@ GEM xcpretty (~> 0.2, >= 0.0.7) PLATFORMS - ruby + arm64-darwin-23 + x86_64-darwin-20 DEPENDENCIES cocoapods @@ -293,4 +305,4 @@ DEPENDENCIES slather BUNDLED WITH - 2.4.10 + 2.5.3 diff --git a/README.md b/README.md index f357d752..277829fe 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.6' +pod 'Auth0', '~> 2.7' ``` 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.6 +github "auth0/Auth0.swift" ~> 2.7 ``` Then, run `carthage bootstrap --use-xcframeworks`. diff --git a/docs/data/documentation/auth0.json b/docs/data/documentation/auth0.json index 23fb5a38..e17a8036 100644 --- a/docs/data/documentation/auth0.json +++ b/docs/data/documentation/auth0.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"externalID":"Auth0","role":"collection","roleHeading":"Framework","title":"Auth0","symbolKind":"module"},"hierarchy":{"paths":[[]]},"abstract":[{"text":"SDK for Apple platforms.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0"]}],"topicSections":[{"title":"Articles","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"]},{"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"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope"],"title":"Variables"},{"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"},{"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"}],"primaryContentSections":[{"kind":"content","content":[{"text":"Overview","level":2,"type":"heading","anchor":"Overview"},{"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":[{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"reference"},{"text":": Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"},{"text":": Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}]}]},{"content":[{"inlineContent":[{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},{"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"}],"type":"paragraph"}]}],"type":"unorderedList"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","title":"JWKS"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AuthenticationResult"}],"type":"topic","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Authentication API operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","role":"symbol","title":"AuthenticationResult","url":"\/documentation\/auth0\/authenticationresult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"kind":"symbol","type":"topic","abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","role":"symbol","title":"defaultScope","url":"\/documentation\/auth0\/defaultscope","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","title":"Logger","url":"\/documentation\/auth0\/logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Logger","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"kind":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","role":"collection","title":"Swift","url":"\/documentation\/auth0\/swift"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"kind":"symbol","abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"role":"symbol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Trackable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","url":"\/documentation\/auth0\/trackable","title":"Trackable"},"https://auth0.com/docs/api/authentication":{"type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"role":"symbol","navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain","kind":"symbol","role":"collection","abstract":[],"title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"kind":"symbol","abstract":[{"type":"text","text":"Auth0 "},{"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."}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"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"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","title":"authentication(clientId:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"kind":"symbol","abstract":[],"role":"collection","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","url":"\/documentation\/auth0\/foundation","title":"Foundation"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"kind":"symbol","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","role":"symbol","title":"DatabaseUser","url":"\/documentation\/auth0\/databaseuser","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"DatabaseUser","kind":"identifier"}]},"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"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","role":"symbol","title":"Loggable","url":"\/documentation\/auth0\/loggable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}]},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"kind":"symbol","abstract":[{"type":"text","text":"Auth0 "},{"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":" "},{"text":"endpoints.","type":"text"}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Users","preciseIdentifier":"s:5Auth05UsersP"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","url":"\/documentation\/auth0\/users(token:domain:session:)","title":"users(token:domain:session:)"},"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"kind":"symbol","abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"type":"text","text":" to perform a web-based operation."},{"text":" ","type":"text"},{"type":"text","text":"The "},{"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."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"kind":"symbol","abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":" client to authenticate your user using Database,","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Social, Enterprise or Passwordless connections."}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","url":"\/documentation\/auth0\/authentication(session:bundle:)","title":"authentication(session:bundle:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"type":"topic","url":"\/documentation\/auth0\/useragents","kind":"article","role":"article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"url":"\/documentation\/auth0\/users(token:session:bundle:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"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"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"text":"Users","kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","type":"topic","title":"users(token:session:bundle:)","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Auth0 "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":" client to perform operations with the Users","type":"text"},{"type":"text","text":" "},{"type":"text","text":"endpoints."}]},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","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":"."}],"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"webAuth(clientId:domain:session:)","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","url":"\/documentation\/auth0\/webauth(session:bundle:)","type":"topic","title":"webAuth(session:bundle:)","kind":"symbol","abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"reference"},{"type":"text","text":"."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth"}]},"https://auth0.com/docs/api/management/v2":{"identifier":"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","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","url":"\/documentation\/auth0\/managementresult","type":"topic","title":"ManagementResult","kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Management API operations."}],"navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"}],"abstract":[{"text":"Callback invoked by the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" when the web-based operation concludes."}],"title":"WebAuthProviderCallback","kind":"symbol","url":"\/documentation\/auth0\/webauthprovidercallback","navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"SDK for Apple platforms."}],"topicSections":[{"generated":true,"title":"Articles","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"]},{"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"},{"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"]},{"title":"Enumerations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]},{"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"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0"},"primaryContentSections":[{"content":[{"type":"heading","level":2,"anchor":"Overview","text":"Overview"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","isActive":true},{"text":": Web-based authentication client.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","isActive":true},{"text":": Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","isActive":true},{"text":": Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},{"type":"text","text":": Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"paragraph"}]}]}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"role":"collection","modules":[{"name":"Auth0"}],"externalID":"Auth0","title":"Auth0","symbolKind":"module","roleHeading":"Framework"},"hierarchy":{"paths":[[]]},"variants":[{"paths":["\/documentation\/auth0"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","url":"\/documentation\/auth0\/webauthresult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","role":"symbol","title":"WebAuthResult","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"type":"topic","role":"symbol","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"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier","text":"Bundle"},{"text":") -> ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"}],"title":"authentication(session:bundle:)","url":"\/documentation\/auth0\/authentication(session:bundle:)"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"type":"topic"},"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","titleInlineContent":[{"text":"Management API v2","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","title":"users(token:domain:session:)","kind":"symbol","fragments":[{"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"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/users(token:domain:session:)","role":"symbol","type":"topic","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"},{"text":" ","type":"text"},{"type":"text","text":"endpoints."}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"type":"topic","title":"Trackable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"role":"symbol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}],"url":"\/documentation\/auth0\/webauthprovidercallback","title":"WebAuthProviderCallback","abstract":[{"type":"text","text":"Callback invoked by the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" when the web-based operation concludes.","type":"text"}],"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProviderCallback","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","kind":"symbol","role":"collection","title":"Swift","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference"},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProvider","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Users","preciseIdentifier":"s:5Auth05UsersP"}],"url":"\/documentation\/auth0\/users(token:session:bundle:)","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"},{"text":"endpoints.","type":"text"}],"title":"users(token:session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"role":"symbol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","title":"CredentialsManagerResult","type":"topic","url":"\/documentation\/auth0\/credentialsmanagerresult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"type":"topic","title":"Loggable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","role":"symbol","title":"webAuth(clientId:domain:session:)","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"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":") -> "},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Management API operations."}],"url":"\/documentation\/auth0\/managementresult","navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","kind":"symbol","type":"topic","title":"ManagementResult","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/useragents"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"role":"collection","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"title":"Universal Login","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","titleInlineContent":[{"text":"Universal Login","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"type":"topic","title":"Foundation","kind":"symbol","url":"\/documentation\/auth0\/foundation","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Logger"}],"title":"Logger","kind":"symbol","url":"\/documentation\/auth0\/logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Authentication API operations."}],"type":"topic","title":"AuthenticationResult","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationResult"}],"kind":"symbol","navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"url":"\/documentation\/auth0\/authenticationresult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"url":"\/documentation\/auth0\/challenge","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","abstract":[{"type":"text","text":"Auth0 "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","title":"authentication(clientId:domain:session:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"text":"clientId","kind":"externalParam"},{"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":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":") -> ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"defaultScope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","kind":"symbol","type":"topic","title":"defaultScope","url":"\/documentation\/auth0\/defaultscope","abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"WebAuthentication","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"type":"topic","url":"\/documentation\/auth0\/jwks","abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"title":"JWKS","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"role":"symbol","url":"\/documentation\/auth0\/telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Authentication API","type":"link","titleInlineContent":[{"text":"Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webAuth"},{"text":"(","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"text":") -> ","kind":"text"},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth(session:bundle:)","abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true,"type":"reference"},{"type":"text","text":"."}],"title":"webAuth(session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0apierror.json b/docs/data/documentation/auth0/auth0apierror.json index 18e78b19..4716b939 100644 --- a/docs/data/documentation/auth0/auth0apierror.json +++ b/docs/data/documentation/auth0/auth0apierror.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"],"title":"Initializers"},{"title":"Instance Properties","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"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0APIError"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","preciseIdentifier":"s:5Auth00A5ErrorP","text":"Auth0Error"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth00A8APIErrorP","title":"Auth0APIError","roleHeading":"Protocol","symbolKind":"protocol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}]},"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","type":"inheritsFrom","title":"Inherits From"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"],"kind":"relationships","title":"Conforming Types","type":"conformingTypes"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":")"}],"kind":"symbol","required":true,"type":"topic","url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","title":"init(info:statusCode:)"},"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","role":"symbol","type":"topic","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/statuscode","title":"statusCode","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"url":"\/documentation\/auth0\/auth0apierror\/info","abstract":[{"type":"text","text":"Additional information about the error."}],"title":"info","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"required":true,"url":"\/documentation\/auth0\/auth0apierror\/code","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","kind":"symbol","title":"code","abstract":[{"type":"text","text":"The code of the error as a string."}],"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}}} \ No newline at end of file +{"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"]},{"title":"Instance Properties","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"]}],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0APIError"}],"externalID":"s:5Auth00A8APIErrorP","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"symbolKind":"protocol","role":"symbol","roleHeading":"Protocol","title":"Auth0APIError"},"relationshipsSections":[{"kind":"relationships","type":"inheritsFrom","title":"Inherits From","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"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"],"type":"conformingTypes","title":"Conforming Types","kind":"relationships"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"},{"text":" : ","kind":"text"},{"text":"Auth0Error","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","preciseIdentifier":"s:5Auth00A5ErrorP","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/auth0apierror"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"kind":"symbol","abstract":[{"text":"Additional information about the error.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/info","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"title":"info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"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":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"title":"init(info:statusCode:)","kind":"symbol","url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"role":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"required":true,"url":"\/documentation\/auth0\/auth0apierror\/code","abstract":[{"type":"text","text":"The code of the error as a string."}],"title":"code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","title":"statusCode","type":"topic","url":"\/documentation\/auth0\/auth0apierror\/statuscode","abstract":[{"type":"text","text":"HTTP status code of the response."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"kind":"symbol"}}} \ 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 c92f6cf6..e0860c7d 100644 --- a/docs/data/documentation/auth0/auth0apierror/code.json +++ b/docs/data/documentation/auth0/auth0apierror/code.json @@ -1 +1 @@ -{"metadata":{"required":true,"roleHeading":"Instance Property","externalID":"s:5Auth00A8APIErrorP4codeSSvp","role":"symbol","symbolKind":"property","title":"code","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The code of the error as a string."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/code"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"required":true,"url":"\/documentation\/auth0\/auth0apierror\/code","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","kind":"symbol","title":"code","abstract":[{"type":"text","text":"The code of the error as a string."}],"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]}}} \ 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\/Auth0APIError"]]},"sections":[],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"required":true,"roleHeading":"Instance Property","title":"code","externalID":"s:5Auth00A8APIErrorP4codeSSvp","role":"symbol"},"abstract":[{"type":"text","text":"The code of the error as a string."}],"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"role":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"required":true,"url":"\/documentation\/auth0\/auth0apierror\/code","abstract":[{"type":"text","text":"The code of the error as a string."}],"title":"code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"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 f7db4700..9e9326bc 100644 --- a/docs/data/documentation/auth0/auth0apierror/info.json +++ b/docs/data/documentation/auth0/auth0apierror/info.json @@ -1 +1 @@ -{"metadata":{"required":true,"modules":[{"name":"Auth0"}],"title":"info","roleHeading":"Instance Property","externalID":"s:5Auth00A8APIErrorP4infoSDySSypGvp","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"symbolKind":"property"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"abstract":[{"text":"Additional information about the error.","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"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":"] { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/info"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"url":"\/documentation\/auth0\/auth0apierror\/info","abstract":[{"type":"text","text":"Additional information about the error."}],"title":"info","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"abstract":[{"text":"Additional information about the error.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/info"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"] { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"metadata":{"externalID":"s:5Auth00A8APIErrorP4infoSDySSypGvp","required":true,"modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"title":"info","role":"symbol","roleHeading":"Instance Property"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"kind":"symbol","abstract":[{"text":"Additional information about the error.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/info","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"title":"info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"type":"topic"}}} \ 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 189d69e2..fce4ec08 100644 --- a/docs/data/documentation/auth0/auth0apierror/init(info:statuscode:).json +++ b/docs/data/documentation/auth0/auth0apierror/init(info:statuscode:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"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":"parameters"},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"Auth0APIError"},{"text":".","type":"text"}]}],"kind":"content"}],"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"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"},{"kind":"externalParam","text":"statusCode"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"title":"init(info:statusCode:)","symbolKind":"init","required":true,"role":"symbol","roleHeading":"Initializer","externalID":"s:5Auth00A8APIErrorP4info10statusCodexSDySSypG_Sitcfc"},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)"]}],"kind":"symbol","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":")"}],"kind":"symbol","required":true,"type":"topic","url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","title":"init(info:statusCode:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","metadata":{"required":true,"roleHeading":"Initializer","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth00A8APIErrorP4info10statusCodexSDySSypG_Sitcfc","symbolKind":"init","title":"init(info:statusCode:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":")"}]},"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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"}]}]},{"kind":"parameters","parameters":[{"name":"info","content":[{"type":"paragraph","inlineContent":[{"text":"JSON response from Auth0.","type":"text"}]}]},{"name":"statusCode","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP status code of the response."}]}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"code":"Auth0APIError","type":"codeVoice"},{"text":".","type":"text"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"title":"init(info:statusCode:)","kind":"symbol","url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"type":"topic"}}} \ 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 0ca74121..4b97b800 100644 --- a/docs/data/documentation/auth0/auth0apierror/statuscode.json +++ b/docs/data/documentation/auth0/auth0apierror/statuscode.json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","interfaceLanguage":"swift"},"metadata":{"required":true,"role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth00A8APIErrorP10statusCodeSivp","modules":[{"name":"Auth0"}],"title":"statusCode","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"statusCode"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/statuscode"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","role":"symbol","type":"topic","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/statuscode","title":"statusCode","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode"},"metadata":{"symbolKind":"property","title":"statusCode","externalID":"s:5Auth00A8APIErrorP10statusCodeSivp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"roleHeading":"Instance Property","required":true,"role":"symbol","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/statuscode"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","title":"statusCode","type":"topic","url":"\/documentation\/auth0\/auth0apierror\/statuscode","abstract":[{"type":"text","text":"HTTP status code of the response."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0error.json b/docs/data/documentation/auth0/auth0error.json index 96b4685d..c011f7ee 100644 --- a/docs/data/documentation/auth0/auth0error.json +++ b/docs/data/documentation/auth0/auth0error.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation14LocalizedErrorP","text":"LocalizedError"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"CustomDebugStringConvertible","preciseIdentifier":"s:s28CustomDebugStringConvertibleP"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["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"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"],"title":"Inherited By","type":"inheritedBy","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","type":"conformingTypes","title":"Conforming Types"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"metadata":{"title":"Auth0Error","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0Error","kind":"identifier"}],"role":"symbol","roleHeading":"Protocol","externalID":"s:5Auth00A5ErrorP","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"symbolKind":"protocol"},"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"role":"symbol","title":"errorDescription","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/errordescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"type":"topic","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"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"text":"?","kind":"text"}],"kind":"symbol","title":"cause","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any.","type":"text"}],"defaultImplementations":1,"url":"\/documentation\/auth0\/auth0error\/cause-1atql"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError","type":"unresolvable"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error","type":"unresolvable"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/auth0error\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"},{"kind":"text","text":" : "},{"text":"LocalizedError","preciseIdentifier":"s:10Foundation14LocalizedErrorP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s28CustomDebugStringConvertibleP","text":"CustomDebugStringConvertible","kind":"typeIdentifier"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error"]}],"kind":"symbol","metadata":{"role":"symbol","symbolKind":"protocol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"externalID":"s:5Auth00A5ErrorP","modules":[{"name":"Auth0"}],"title":"Auth0Error","roleHeading":"Protocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"},"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"}],"relationshipsSections":[{"type":"inheritsFrom","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"title":"Inherits From"},{"title":"Inherited By","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"],"type":"inheritedBy"},{"title":"Conforming Types","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"],"type":"conformingTypes"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/errordescription","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"required":true,"url":"\/documentation\/auth0\/auth0error\/cause-1atql","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any.","type":"text"}],"title":"cause","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","kind":"symbol"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError","type":"unresolvable"}}} \ 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 9b2688e7..f27634ab 100644 --- a/docs/data/documentation/auth0/auth0error/cause-1atql.json +++ b/docs/data/documentation/auth0/auth0error/cause-1atql.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"title":"cause","symbolKind":"property","required":true,"roleHeading":"Instance Property","role":"symbol","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"}]},"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"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any."}],"sections":[],"defaultImplementationsSections":[{"title":"Auth0Error Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/cause-1atql"]}],"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"type":"topic","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"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"text":"?","kind":"text"}],"kind":"symbol","title":"cause","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any.","type":"text"}],"defaultImplementations":1,"url":"\/documentation\/auth0\/auth0error\/cause-1atql"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"roleHeading":"Instance Property","required":true,"modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"role":"symbol","externalID":"s:5Auth00A5ErrorP5causes0B0_pSgvp","title":"cause"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"defaultImplementationsSections":[{"title":"Auth0Error Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/cause-1atql"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"required":true,"url":"\/documentation\/auth0\/auth0error\/cause-1atql","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any.","type":"text"}],"title":"cause","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}}} \ 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 37a67d46..d79676a2 100644 --- a/docs/data/documentation/auth0/auth0error/cause-9wuyi.json +++ b/docs/data/documentation/auth0/auth0error/cause-9wuyi.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth00A5ErrorPAAE5causes0B0_pSgvp","extendedModule":"Auth0","title":"cause"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/cause-9wuyi"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","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\/Auth0Error","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql"]]},"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"type":"topic","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"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"text":"?","kind":"text"}],"kind":"symbol","title":"cause","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any.","type":"text"}],"defaultImplementations":1,"url":"\/documentation\/auth0\/auth0error\/cause-1atql"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]}}} \ No newline at end of file +{"abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/cause-9wuyi"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","metadata":{"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","extendedModule":"Auth0","title":"cause","externalID":"s:5Auth00A5ErrorPAAE5causes0B0_pSgvp"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"required":true,"url":"\/documentation\/auth0\/auth0error\/cause-1atql","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any.","type":"text"}],"title":"cause","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","kind":"symbol"}}} \ 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 db75634e..da1c217a 100644 --- a/docs/data/documentation/auth0/auth0error/errordescription.json +++ b/docs/data/documentation/auth0/auth0error/errordescription.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Description of the error."}],"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"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/errordescription"]}],"kind":"symbol","sections":[],"metadata":{"role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","extendedModule":"Auth0","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp","title":"errorDescription"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"type":"aside","style":"important","name":"Important","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"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"role":"symbol","title":"errorDescription","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/errordescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Description of the error.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"style":"important","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"}]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/errordescription"]}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"errorDescription","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/errordescription","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 067f6806..9626094b 100644 --- a/docs/data/documentation/auth0/auth0error/localizeddescription.json +++ b/docs/data/documentation/auth0/auth0error/localizeddescription.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/localizeddescription"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Discussion","anchor":"discussion"},{"type":"aside","style":"important","name":"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":[{"text":"debugging","type":"text"}]},{"text":" only.","type":"text"}]}]}]}],"sections":[],"kind":"symbol","metadata":{"title":"localizedDescription","symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp","extendedModule":"Auth0","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"abstract":[{"type":"text","text":"Description of the error."}],"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/auth0error\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"abstract":[{"text":"Description of the error.","type":"text"}],"metadata":{"title":"localizedDescription","extendedModule":"Auth0","roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]},{"kind":"content","content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"name":"Important","type":"aside","style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"type":"text","text":" only."}]}]}]}],"variants":[{"paths":["\/documentation\/auth0\/auth0error\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 4753cc1b..953fe8b1 100644 --- a/docs/data/documentation/auth0/authentication(clientid:domain:session:).json +++ b/docs/data/documentation/auth0/authentication(clientid:domain:session:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":" = .shared) -> "},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"clientId","content":[{"inlineContent":[{"type":"text","text":"Client ID of your Auth0 application."}],"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":""},{"type":"codeVoice","code":"URLSession"},{"text":" instance used for networking. Defaults to ","type":"text"},{"code":"URLSession.shared","type":"codeVoice"},{"type":"text","text":"."}]}]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"Auth0 Authentication API client."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"syntax":"swift","code":["Auth0.authentication(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"],"type":"codeListing"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)"},"abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication(clientid:domain:session:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Function","title":"authentication(clientId:domain:session:)","modules":[{"name":"Auth0"}],"symbolKind":"func","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"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"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"role":"symbol","externalID":"s:5Auth014authentication8clientId6domain7sessionAA14Authentication_pSS_SSSo12NSURLSessionCtF"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"kind":"symbol","abstract":[{"type":"text","text":"Auth0 "},{"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."}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"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"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","title":"authentication(clientId:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Function","title":"authentication(clientId:domain:session:)","symbolKind":"func","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier","text":"Authentication"}],"role":"symbol","externalID":"s:5Auth014authentication8clientId6domain7sessionAA14Authentication_pSS_SSSo12NSURLSessionCtF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":" = .shared) -> "},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"clientId","content":[{"type":"paragraph","inlineContent":[{"text":"Client ID of your Auth0 application.","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"Domain of your Auth0 account, for example ","type":"text"},{"code":"samples.us.auth0.com","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"domain"},{"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":"."}]}],"name":"session"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"Auth0 Authentication API client."}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"type":"codeListing","code":["Auth0.authentication(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"],"syntax":"swift"}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication(clientid:domain:session:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","abstract":[{"type":"text","text":"Auth0 "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","title":"authentication(clientId:domain:session:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"text":"clientId","kind":"externalParam"},{"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":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":") -> ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication":{"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"}],"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 088cc5ce..a8c36024 100644 --- a/docs/data/documentation/auth0/authentication(session:bundle:).json +++ b/docs/data/documentation/auth0/authentication(session:bundle:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authentication(session:bundle:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"session"},{"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":" = .main) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"session","content":[{"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"}],"type":"paragraph"}]},{"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"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"bundle"}],"kind":"parameters"},{"content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"Auth0 Authentication API client."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"code":["Auth0.authentication()"],"syntax":"swift","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"},{"text":" ","type":"text"},{"type":"text","text":"content:"}],"type":"paragraph"},{"syntax":"xml","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"type":"codeListing"},{"type":"aside","style":"warning","name":"Warning","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Calling this method without a valid "},{"type":"codeVoice","code":"Auth0.plist"},{"type":"text","text":" file will crash your application."}]}]}],"kind":"content"}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","interfaceLanguage":"swift"},"metadata":{"symbolKind":"func","roleHeading":"Function","modules":[{"name":"Auth0"}],"title":"authentication(session:bundle:)","role":"symbol","externalID":"s:5Auth014authentication7session6bundleAA14Authentication_pSo12NSURLSessionC_So8NSBundleCtF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"text":"(","kind":"text"},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier","text":"Authentication"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Auth0 "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":" client to authenticate your user using Database,"},{"type":"text","text":" "},{"text":"Social, Enterprise or Passwordless connections.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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/authentication(session:bundle:)":{"kind":"symbol","abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":" client to authenticate your user using Database,","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Social, Enterprise or Passwordless connections."}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","url":"\/documentation\/auth0\/authentication(session:bundle:)","title":"authentication(session:bundle:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth014authentication7session6bundleAA14Authentication_pSo12NSURLSessionC_So8NSBundleCtF","role":"symbol","roleHeading":"Function","symbolKind":"func","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier"}],"title":"authentication(session:bundle:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"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,"},{"type":"text","text":" "},{"type":"text","text":"Social, Enterprise or Passwordless connections."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication(session:bundle:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"authentication"},{"text":"(","kind":"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"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"kind":"text","text":" = .main) -> "},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"session","content":[{"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":"."}],"type":"paragraph"}]},{"name":"bundle","content":[{"type":"paragraph","inlineContent":[{"text":"Bundle used to locate the ","type":"text"},{"type":"codeVoice","code":"Auth0.plist"},{"type":"text","text":" file. Defaults to "},{"type":"codeVoice","code":"Bundle.main"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"Auth0 Authentication API client."}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","level":2,"type":"heading","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"},{"type":"text","text":" file in your main bundle. It should have the following"},{"type":"text","text":" "},{"type":"text","text":"content:"}],"type":"paragraph"},{"type":"codeListing","syntax":"xml","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"]},{"style":"warning","content":[{"type":"paragraph","inlineContent":[{"text":"Calling this method without a valid ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file will crash your application."}]}],"name":"Warning","type":"aside"}],"kind":"content"}],"sections":[],"references":{"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/authentication(session:bundle:)":{"type":"topic","role":"symbol","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"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier","text":"Bundle"},{"text":") -> ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"}],"title":"authentication(session:bundle:)","url":"\/documentation\/auth0\/authentication(session:bundle:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication.json b/docs/data/documentation/auth0/authentication.json index b0e92cd9..557d5781 100644 --- a/docs/data/documentation/auth0/authentication.json +++ b/docs/data/documentation/auth0/authentication.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"text":".","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth08LoggableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","text":"Loggable"},{"kind":"text","text":", "},{"text":"Trackable","preciseIdentifier":"s:5Auth09TrackableP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"paths":["\/documentation\/auth0\/authentication"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"externalID":"s:5Auth014AuthenticationP","symbolKind":"protocol","title":"Authentication","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"roleHeading":"Protocol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"modules":[{"name":"Auth0"}]},"sections":[],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"],"title":"Instance Properties"},{"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:)"],"title":"Instance Methods"}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"],"title":"Related Documentation"}],"relationshipsSections":[{"type":"inheritsFrom","title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"kind":"relationships"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"type":"topic","required":true,"defaultImplementations":1,"title":"login(email:code:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","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"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"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."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","role":"symbol"},"https://auth0.com/docs/api/authentication#standard-error-responses":{"title":"Standard Error Responses","titleInlineContent":[{"text":"Standard Error Responses","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"type":"topic","url":"\/documentation\/auth0\/authentication\/url","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"required":true,"kind":"symbol","title":"url","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol","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"},{"type":"text","text":"login flow."}],"defaultImplementations":1,"type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","title":"startPasswordless(phoneNumber:type:connection:)","required":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"userInfo","kind":"identifier"},{"kind":"text","text":"("},{"text":"withAccessToken","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":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"required":true,"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"role":"symbol","title":"userInfo(withAccessToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)","url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"kind":"symbol","abstract":[{"text":"Logs in a user using a username and password with a realm or connection.","type":"text"}],"defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a recovery code."},{"type":"text","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","type":"text"},{"type":"text","text":" "},{"text":"it due to connectivity issues.","type":"text"}],"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"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":">"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","title":"login(withRecoveryCode:mfaToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","role":"symbol","title":"Loggable","url":"\/documentation\/auth0\/loggable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOTP","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","type":"topic","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"required":true,"kind":"symbol","title":"login(withOTP:mfaToken:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","type":"topic","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]?, "},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"defaultImplementations":1,"abstract":[{"type":"text","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."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"title":"resetPassword(email:connection:)","url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","required":true,"type":"topic","abstract":[{"type":"text","text":"Resets the password of a database user."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","defaultImplementations":1,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","required":true,"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","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":" "},{"text":"or voice).","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","defaultImplementations":1,"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"rootAttributes"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"text":"Creates a user in a database connection.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"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":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"required":true,"title":"renew(withRefreshToken:scope:)","role":"symbol","type":"topic","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","required":true,"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"loginDefaultDirectory"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","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"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","defaultImplementations":1,"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"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"},{"kind":"text","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":">"}],"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","kind":"symbol","required":true,"type":"topic","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"redirectURI","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"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"},{"text":">","kind":"text"}],"title":"codeExchange(withCode:codeVerifier:redirectURI:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","type":"topic","role":"symbol","abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"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":"."}]},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"type":"link","title":"session info access token","url":"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\/","titleInlineContent":[{"type":"text","text":"session info access token"}]},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-56xbe":{"required":true,"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","kind":"symbol","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."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"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":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","title":"startPasswordless(email:type:connection:)","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"text":"refreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"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."}],"title":"revoke(refreshToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","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","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"defaultImplementations":1,"title":"login(facebookSessionAccessToken:profile:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","type":"topic","role":"symbol","kind":"symbol","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\/"},{"text":" and profile data.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"kind":"symbol","abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"role":"symbol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Trackable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","url":"\/documentation\/auth0\/trackable","title":"Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-38nv0":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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"},{"kind":"text","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"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"login(phoneNumber:code:audience:scope:)","defaultImplementations":1,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","required":true,"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","type":"topic","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."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"title":"clientId","required":true,"url":"\/documentation\/auth0\/authentication\/clientid","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/jwks()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"jwks"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier","text":"JWKS"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"jwks()","abstract":[{"type":"text","text":"Returns JSON Web Key Set (JWKS) information from the "},{"code":"\/.well-known\/jwks.json","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","role":"symbol","required":true}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"},{"text":" : ","kind":"text"},{"text":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","preciseIdentifier":"s:5Auth08LoggableP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TrackableP"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"title":"Inherits From","type":"inheritsFrom","kind":"relationships"}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"]},{"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:)"],"title":"Instance Methods"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"]}],"metadata":{"role":"symbol","roleHeading":"Protocol","externalID":"s:5Auth014AuthenticationP","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"symbolKind":"protocol","title":"Authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication"]}],"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/clientid","title":"clientId","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"required":true,"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"defaultImplementations":1,"required":true,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","type":"topic","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","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"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"type":"topic","title":"Trackable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","title":"login(withOTP:mfaToken:)","abstract":[{"text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP).","type":"text"}],"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOTP","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"kind":"symbol","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"authenticatorId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier","text":"Challenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","required":true,"defaultImplementations":1},"https://auth0.com/docs/api/authentication#standard-error-responses":{"title":"Standard Error Responses","titleInlineContent":[{"text":"Standard Error Responses","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"},"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\/","url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","title":"session info access token","type":"link","titleInlineContent":[{"type":"text","text":"session info access token"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"defaultImplementations":1,"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"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"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"title":"login(withOOBCode:mfaToken:bindingCode:)","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"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"title":"renew(withRefreshToken:scope:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","role":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"text":"withRefreshToken","kind":"externalParam"},{"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"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"type":"topic","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"kind":"symbol","url":"\/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"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","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"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"startPasswordless(phoneNumber:type:connection:)","defaultImplementations":1,"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","type":"topic","abstract":[{"text":"Resets the password of a database user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","title":"resetPassword(email:connection:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"resetPassword"},{"text":"(","kind":"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","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"text":"withAccessToken","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":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)","abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"text":" endpoint.","type":"text"}],"title":"userInfo(withAccessToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"abstract":[{"text":"Revokes a user’s refresh token by performing a request to the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"refreshToken","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"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"revoke(refreshToken:)","url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"type":"topic","title":"Loggable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},"doc://com.auth0.Auth0/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."}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","type":"topic","kind":"symbol","required":true,"role":"symbol","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"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"title":"login(withRecoveryCode:mfaToken:)","type":"topic","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a recovery code."},{"type":"text","text":" "},{"text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to","type":"text"},{"text":" ","type":"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"},{"type":"text","text":"it due to connectivity issues."}],"url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRecoveryCode"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"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","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"kind":"symbol","required":true,"role":"symbol"},"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"},{"text":"passwordless login flow.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","kind":"symbol","required":true,"role":"symbol","defaultImplementations":1,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"startPasswordless(email:type:connection:)","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"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":">"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","title":"login(email:code:audience:scope:)","required":true,"role":"symbol","defaultImplementations":1,"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":" "},{"text":"flow.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","kind":"symbol","url":"\/documentation\/auth0\/authentication\/url","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"required":true,"title":"url","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","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":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","defaultImplementations":1,"role":"symbol","kind":"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."}],"type":"topic","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"signup"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"text":": ","kind":"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":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"userMetadata","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":"rootAttributes"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","role":"symbol","defaultImplementations":1,"required":true,"type":"topic","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"title":"codeExchange(withCode:codeVerifier:redirectURI:)","url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","kind":"symbol","required":true,"role":"symbol","abstract":[{"type":"text","text":"Performs the last step of Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"text":"This will request the user’s tokens using the code and its verifier after a request to ","type":"text"},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"codeExchange"},{"text":"(","kind":"text"},{"text":"withCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"codeVerifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"redirectURI","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","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"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"kind":"symbol","abstract":[{"text":"Returns JSON Web Key Set (JWKS) information from the ","type":"text"},{"code":"\/.well-known\/jwks.json","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/jwks()","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"JWKS","kind":"typeIdentifier","preciseIdentifier":"s:5Auth04JWKSV"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"jwks()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","role":"symbol","type":"topic"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","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:)-7k4xo","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PersonNameComponents","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"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"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","role":"symbol","defaultImplementations":1,"required":true,"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"required":true,"defaultImplementations":1,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","title":"login(facebookSessionAccessToken:profile:audience:scope:)","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\/"},{"text":" and profile data.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","kind":"symbol"}}} \ 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 0e876392..4cb9f94e 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"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"title":"clientId","modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","externalID":"s:5Auth014AuthenticationP8clientIdSSvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"roleHeading":"Instance Property","required":true},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"text":"The Auth0 Client ID.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"title":"clientId","required":true,"url":"\/documentation\/auth0\/authentication\/clientid","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId"},"https://auth0.com/docs/api/authentication":{"type":"link","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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/clientid"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId"},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","abstract":[{"text":"The Auth0 Client ID.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"metadata":{"role":"symbol","symbolKind":"property","externalID":"s:5Auth014AuthenticationP8clientIdSSvp","modules":[{"name":"Auth0"}],"required":true,"title":"clientId","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/api/authentication":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/clientid","title":"clientId","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"required":true,"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId"}}} \ 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 692ce4d0..00370a63 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 @@ -{"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"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"},"abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"text":" ","type":"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"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","https:\/\/tools.ietf.org\/html\/rfc7636"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"text":"(","kind":"text"},{"text":"withCode","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"code"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"codeVerifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"redirectURI","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Code returned after a request to "},{"code":"\/oauth\/authorize","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"code"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Verifier used to generate the challenge sent in the request to ","type":"text"},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}]}],"name":"codeVerifier"},{"name":"redirectURI","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Redirect URI sent in the request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"text":".","type":"text"}]}]}]},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"syntax":"swift","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)\")"," }"," }"]}]}],"metadata":{"role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"codeExchange(withCode:codeVerifier:redirectURI:)","roleHeading":"Instance Method","required":true,"externalID":"s:5Auth014AuthenticationP12codeExchange8withCode0C8Verifier11redirectURIAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2StF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"codeExchange"},{"kind":"text","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"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"redirectURI","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","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","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#authorization-code-flow-with-pkce45":{"type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","url":"https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"redirectURI","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"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"},{"text":">","kind":"text"}],"title":"codeExchange(withCode:codeVerifier:redirectURI:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","type":"topic","role":"symbol","abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"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":"."}]},"https://tools.ietf.org/html/rfc7636":{"type":"link","identifier":"https:\/\/tools.ietf.org\/html\/rfc7636","titleInlineContent":[{"type":"text","text":"RFC 7636"}],"url":"https:\/\/tools.ietf.org\/html\/rfc7636","title":"RFC 7636"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"title":"codeExchange(withCode:codeVerifier:redirectURI:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"text":"withCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"redirectURI"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","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"}],"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth014AuthenticationP12codeExchange8withCode0C8Verifier11redirectURIAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2StF","required":true,"symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","interfaceLanguage":"swift"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"codeExchange"},{"text":"(","kind":"text"},{"text":"withCode","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"code","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"codeVerifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"redirectURI"},{"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"},{"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"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Code returned after a request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}]}],"name":"code"},{"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":[{"type":"text","text":"Redirect URI sent in the request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"redirectURI"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"content":[{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"type":"codeListing","syntax":"swift","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)\")"," }"," }"]}],"kind":"content"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"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 "},{"code":"\/oauth\/authorize","type":"codeVoice"},{"type":"text","text":"."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","https:\/\/tools.ietf.org\/html\/rfc7636"],"title":"Related Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#authorization-code-flow-with-pkce45":{"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"title":"codeExchange(withCode:codeVerifier:redirectURI:)","url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","kind":"symbol","required":true,"role":"symbol","abstract":[{"type":"text","text":"Performs the last step of Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"text":"This will request the user’s tokens using the code and its verifier after a request to ","type":"text"},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"codeExchange"},{"text":"(","kind":"text"},{"text":"withCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"codeVerifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"redirectURI","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","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"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"https://tools.ietf.org/html/rfc7636":{"title":"RFC 7636","url":"https:\/\/tools.ietf.org\/html\/rfc7636","titleInlineContent":[{"type":"text","text":"RFC 7636"}],"identifier":"https:\/\/tools.ietf.org\/html\/rfc7636","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication":{"identifier":"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"}]}}} \ 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 435b3285..d1e8c83e 100644 --- a/docs/data/documentation/auth0/authentication/jwks().json +++ b/docs/data/documentation/auth0/authentication/jwks().json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"jwks"},{"kind":"text","text":"() -> "},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","kind":"typeIdentifier","text":"JWKS","preciseIdentifier":"s:5Auth04JWKSV"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}]}],"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":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"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"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"jwks"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth04JWKSV","text":"JWKS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"externalID":"s:5Auth014AuthenticationP4jwksAA7RequestVyAA4JWKSVAA0B5ErrorVGyF","roleHeading":"Instance Method","title":"jwks()"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/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."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/jwks()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"jwks"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier","text":"JWKS"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"jwks()","abstract":[{"type":"text","text":"Returns JSON Web Key Set (JWKS) information from the "},{"code":"\/.well-known\/jwks.json","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","role":"symbol","required":true},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"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","type":"link","title":"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"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","title":"JWKS"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"abstract":[{"text":"Returns JSON Web Key Set (JWKS) information from the ","type":"text"},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"text":" endpoint.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth04JWKSV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","text":"JWKS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield JWKS information.","type":"text"}]}]},{"kind":"content","content":[{"anchor":"Usage","type":"heading","text":"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)\")"," }"," }"]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/authentication\/jwks()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth04JWKSV","text":"JWKS"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP4jwksAA7RequestVyAA4JWKSVAA0B5ErrorVGyF","required":true,"title":"jwks()"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"type":"topic","url":"\/documentation\/auth0\/jwks","abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"title":"JWKS","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"kind":"symbol","abstract":[{"text":"Returns JSON Web Key Set (JWKS) information from the ","type":"text"},{"code":"\/.well-known\/jwks.json","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/jwks()","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"JWKS","kind":"typeIdentifier","preciseIdentifier":"s:5Auth04JWKSV"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"jwks()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"https://auth0.com/docs/api/authentication":{"type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"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","title":"JSON Web Key Sets","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","titleInlineContent":[{"type":"text","text":"JSON Web Key Sets"}]}}} \ 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 aef3c68f..4ad3ed06 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 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m"]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"],"title":"Related Documentation"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"authorizationCode"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PersonNameComponents","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"? = nil, "},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" = defaultScope) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Authorization Code retrieved from Apple Authorization.","type":"text"}]}],"name":"authorizationCode"},{"name":"fullName","content":[{"type":"paragraph","inlineContent":[{"text":"The full name property returned with the Apple ID Credentials.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional user profile data returned with the Apple ID Credentials."}]}],"name":"profile"},{"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"},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}]}]}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"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"},{"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)\")"," }"," }"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"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","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(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo"]]},"sections":[],"abstract":[{"text":"Authenticates a user with their Sign In with Apple authorization code.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"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"}],"role":"symbol","roleHeading":"Instance Method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","symbolKind":"method","externalID":"s:5Auth014AuthenticationPAAE5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"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"},{"kind":"text","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":">"}],"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","kind":"symbol","required":true,"type":"topic","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"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","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"text":"?, ","kind":"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":"]?, "},{"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"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","kind":"symbol","type":"topic","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"},"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/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m"]}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","symbolKind":"method","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","role":"symbol","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"appleAuthorizationCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"text":": [","kind":"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"},{"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"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"sections":[],"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","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"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"authorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]? = nil, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","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":">"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"authorizationCode","content":[{"inlineContent":[{"text":"Authorization Code retrieved from Apple Authorization.","type":"text"}],"type":"paragraph"}]},{"name":"fullName","content":[{"type":"paragraph","inlineContent":[{"text":"The full name property returned with the Apple ID Credentials.","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Additional user profile data returned with the Apple ID Credentials."}],"type":"paragraph"}],"name":"profile"},{"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"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"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"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"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","syntax":"swift"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","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","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","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"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"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","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"https://auth0.com/docs/api/authentication":{"url":"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"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","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:)-7k4xo","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PersonNameComponents","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"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"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","role":"symbol","defaultImplementations":1,"required":true,"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 67b084f0..deb16a78 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 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"appleAuthorizationCode","kind":"externalParam"},{"kind":"text","text":" "},{"text":"authorizationCode","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"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","text":"String","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"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Authorization Code retrieved from Apple Authorization.","type":"text"}]}],"name":"authorizationCode"},{"content":[{"inlineContent":[{"text":"The full name property returned with the Apple ID Credentials.","type":"text"}],"type":"paragraph"}],"name":"fullName"},{"name":"profile","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional user profile data returned with the Apple ID Credentials."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"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":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"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":[{"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) }"],"type":"codeListing","syntax":"swift"}],"kind":"content"}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fullName"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"?, "},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","required":true,"externalID":"s:5Auth014AuthenticationP5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","symbolKind":"method"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"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(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo"]}],"kind":"symbol","sections":[],"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","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"text":"?, ","kind":"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":"]?, "},{"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"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","kind":"symbol","type":"topic","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)"},"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","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"},"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"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"},{"kind":"text","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":">"}],"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","kind":"symbol","required":true,"type":"topic","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"],"title":"Authentication Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"authorizationCode"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents","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"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","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":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"authorizationCode","content":[{"inlineContent":[{"text":"Authorization Code retrieved from Apple Authorization.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"The full name property returned with the Apple ID Credentials."}],"type":"paragraph"}],"name":"fullName"},{"name":"profile","content":[{"inlineContent":[{"type":"text","text":"Additional user profile data returned with the Apple ID Credentials."}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}]},{"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":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"content":[{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"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)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"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"}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"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"]}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"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":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","required":true,"role":"symbol","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","modules":[{"name":"Auth0"}],"symbolKind":"method"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Authenticates a user with their Sign In with Apple authorization code.","type":"text"}],"sections":[],"references":{"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/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","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:)-7k4xo","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PersonNameComponents","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"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"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","role":"symbol","defaultImplementations":1,"required":true,"type":"topic","kind":"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","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","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","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"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"type":"topic"}}} \ 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 8bb6a2a9..397407e1 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 @@ -{"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"},{"type":"text","text":" "},{"text":"flow.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" = defaultScope) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"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":", "},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"name":"email","content":[{"inlineContent":[{"type":"text","text":"Email the user used to start the passwordless login flow."}],"type":"paragraph"}]},{"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"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}]},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"type":"codeListing","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)\")"," }"," }"]},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"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) }"],"syntax":"swift","type":"codeListing"},{"name":"Requires","content":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"text":". 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":"paragraph"}],"style":"note","type":"aside"}],"kind":"content"}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","title":"login(email:code:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"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"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b"],"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(email:code:audience:scope:)-587bo"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b"},"references":{"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"title":"Error Responses","titleInlineContent":[{"type":"text","text":"Error Responses"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"type":"topic","title":"login(email:code:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"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"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"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"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"type":"topic","required":true,"defaultImplementations":1,"title":"login(email:code:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","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"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"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."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#authenticate-user":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"titleInlineContent":[{"text":"our documentation","type":"text"}],"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"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"],"title":"Related Documentation"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"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"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" = defaultScope) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Email the user used to start the passwordless login flow."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"One-time password (OTP) code the user received via email.","type":"text"}]}],"name":"code"},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"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"},{"type":"text","text":"."}]}],"name":"scope"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"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"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]},{"style":"note","type":"aside","name":"Requires","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"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}],"type":"paragraph"}]}]}],"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"},{"type":"text","text":" "},{"type":"text","text":"flow."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","interfaceLanguage":"swift"},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","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"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method","title":"login(email:code:audience:scope:)","externalID":"s:5Auth014AuthenticationPAAE5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","extendedModule":"Auth0"},"sections":[],"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"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"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"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","title":"login(email:code:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","role":"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"},{"text":"flow.","type":"text"}]},"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"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"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","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"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":">"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","title":"login(email:code:audience:scope:)","required":true,"role":"symbol","defaultImplementations":1,"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":" "},{"text":"flow.","type":"text"}]},"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/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","type":"link","title":"Error Responses","titleInlineContent":[{"type":"text","text":"Error Responses"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 50113d95..fee411f2 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 @@ -{"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","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":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}],"title":"login(email:code:audience:scope:)","roleHeading":"Instance Method","required":true,"externalID":"s:5Auth014AuthenticationP5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","symbolKind":"method","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"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."}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b"],"title":"Authentication Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo"]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"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":", "},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"parameters":[{"name":"email","content":[{"inlineContent":[{"text":"Email the user used to start the passwordless login flow.","type":"text"}],"type":"paragraph"}]},{"name":"code","content":[{"type":"paragraph","inlineContent":[{"text":"One-time password (OTP) code the user received via email.","type":"text"}]}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}]},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","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)\")"," }"," }"]},{"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()"," .login(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]},{"type":"aside","style":"note","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"},{"type":"text","text":" for more information."}],"type":"paragraph"}],"name":"Requires"}],"kind":"content"}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","interfaceLanguage":"swift"},"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/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"type":"link","title":"Error Responses","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/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication#authenticate-user":{"title":"Authentication API Endpoint","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"},"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","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"text":"our documentation","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"type":"topic","title":"login(email:code:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"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"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"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"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","role":"symbol"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"type":"topic","required":true,"defaultImplementations":1,"title":"login(email:code:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","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"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"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."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","role":"symbol"}}} \ No newline at end of file +{"sections":[],"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"},{"text":"flow.","type":"text"}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"login(email:code:audience:scope:)","externalID":"s:5Auth014AuthenticationP5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","role":"symbol","required":true,"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"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"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"email","content":[{"inlineContent":[{"type":"text","text":"Email the user used to start the passwordless login flow."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"One-time password (OTP) code the user received via email.","type":"text"}],"type":"paragraph"}],"name":"code"},{"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":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"scope"}]},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"syntax":"swift","type":"codeListing","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)\")"," }"," }"]},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"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) }"],"syntax":"swift","type":"codeListing"},{"type":"aside","style":"note","content":[{"inlineContent":[{"text":"Passwordless OTP Grant ","type":"text"},{"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},{"text":" for more information.","type":"text"}],"type":"paragraph"}],"name":"Requires"}]}],"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\/login(email:code:audience:scope:)-587bo","interfaceLanguage":"swift"},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b"],"title":"Authentication Implementations"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"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","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#authenticate-user":{"type":"link","url":"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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"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":">"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","title":"login(email:code:audience:scope:)","required":true,"role":"symbol","defaultImplementations":1,"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":" "},{"text":"flow.","type":"text"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"text":"our documentation","type":"text"}],"title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"titleInlineContent":[{"text":"Error Responses","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","title":"Error Responses","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"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"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","title":"login(email:code:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","role":"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"},{"text":"flow.","type":"text"}]}}} \ 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 95a6feba..daf7aba2 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","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\/"},{"text":" and profile data.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"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"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","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":[{"name":"sessionAccessToken","content":[{"inlineContent":[{"type":"text","text":"Session info access token retrieved from Facebook."}],"type":"paragraph"}]},{"name":"profile","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The user profile data retrieved from Facebook."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"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"},{"type":"text","text":"."}]}]}]},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"syntax":"swift","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"},{"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(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"],"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj"]}],"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(facebookSessionAccessToken:profile:audience:scope:)-8wh5g"]]},"metadata":{"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","modules":[{"name":"Auth0"}],"role":"symbol","title":"login(facebookSessionAccessToken:profile:audience:scope:)","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"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":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"symbolKind":"method"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","type":"topic","role":"symbol","kind":"symbol","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"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","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","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"defaultImplementations":1,"title":"login(facebookSessionAccessToken:profile:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","type":"topic","role":"symbol","kind":"symbol","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\/"},{"text":" and profile data.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"titleInlineContent":[{"text":"session info access token","type":"text"}],"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\/"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj"},"abstract":[{"type":"text","text":"Authenticates a user with their Facebook "},{"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","type":"reference","isActive":true},{"text":" and profile data.","type":"text"}],"metadata":{"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"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"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationPAAE5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","extendedModule":"Auth0","role":"symbol","title":"login(facebookSessionAccessToken:profile:audience:scope:)","modules":[{"name":"Auth0"}],"symbolKind":"method"},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"],"title":"Related Documentation"}],"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"sessionAccessToken","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" = defaultScope) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","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","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Session info access token retrieved from Facebook.","type":"text"}],"type":"paragraph"}],"name":"sessionAccessToken"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The user profile data retrieved from Facebook.","type":"text"}]}],"name":"profile"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"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":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"type":"codeListing","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) }"]}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"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"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"required":true,"defaultImplementations":1,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","title":"login(facebookSessionAccessToken:profile:audience:scope:)","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\/"},{"text":" and profile data.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","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"},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"type":"link","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","titleInlineContent":[{"type":"text","text":"session info access token"}],"title":"session info access token","url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"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/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","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"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"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"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","title":"login(facebookSessionAccessToken:profile:audience:scope:)","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\/"},{"text":" and profile data.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","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 097530d5..920824a7 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 @@ -{"sections":[],"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."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"symbolKind":"method","role":"symbol","roleHeading":"Instance Method","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"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"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"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","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"text":" ","kind":"text"},{"text":"sessionAccessToken","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"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"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Session info access token retrieved from Facebook.","type":"text"}]}],"name":"sessionAccessToken"},{"name":"profile","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The user profile data retrieved from Facebook."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","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":"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"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g"},"kind":"symbol","defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","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","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"defaultImplementations":1,"title":"login(facebookSessionAccessToken:profile:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","type":"topic","role":"symbol","kind":"symbol","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\/"},{"text":" and profile data.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"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":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","type":"topic","role":"symbol","kind":"symbol","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"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"titleInlineContent":[{"text":"session info access token","type":"text"}],"url":"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"}}} \ No newline at end of file +{"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":" "},{"kind":"internalParam","text":"sessionAccessToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","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"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"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"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Session info access token retrieved from Facebook."}],"type":"paragraph"}],"name":"sessionAccessToken"},{"name":"profile","content":[{"inlineContent":[{"type":"text","text":"The user profile data retrieved from Facebook."}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}]},{"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":"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 Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"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":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"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"}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Instance Method","required":true,"externalID":"s:5Auth014AuthenticationP5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","modules":[{"name":"Auth0"}],"symbolKind":"method","title":"login(facebookSessionAccessToken:profile:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"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"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"kind":"text","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"},{"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"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."}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj"],"title":"Authentication Implementations"}],"references":{"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","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"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"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"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","title":"login(facebookSessionAccessToken:profile:audience:scope:)","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\/"},{"text":" and profile data.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"required":true,"defaultImplementations":1,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","title":"login(facebookSessionAccessToken:profile:audience:scope:)","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\/"},{"text":" and profile data.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"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"},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"titleInlineContent":[{"text":"session info access token","type":"text"}],"type":"link","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\/","title":"session info access token"}}} \ 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 bb252495..e6038cca 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 @@ -{"metadata":{"required":true,"role":"symbol","externalID":"s:5Auth014AuthenticationP5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"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":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"modules":[{"name":"Auth0"}],"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."}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii"],"title":"Authentication Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"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"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","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"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"type":"text","text":"Phone number the user used to start the passwordless login flow."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"One-time password (OTP) code the user received via SMS.","type":"text"}]}],"name":"code"},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"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":"."}]}],"name":"scope"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"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)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"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","type":"aside","name":"Requires","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":" "},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true,"type":"reference"},{"type":"text","text":" for more information."}]}]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-38nv0":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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"},{"kind":"text","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"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"login(phoneNumber:code:audience:scope:)","defaultImplementations":1,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","required":true,"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","type":"topic","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."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"titleInlineContent":[{"type":"text","text":"Error Responses"}],"title":"Error Responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","type":"link"},"https://auth0.com/docs/api/authentication#authenticate-user":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","type":"link","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/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"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","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","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":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"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","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"login(phoneNumber:code:audience:scope:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","type":"topic","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."}]},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"login(phoneNumber:code:audience:scope:)","externalID":"s:5Auth014AuthenticationP5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"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"},{"kind":"text","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":">"}],"roleHeading":"Instance Method","required":true,"role":"symbol","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"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":", "},{"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"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}]},{"parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"type":"text","text":"Phone number the user used to start the passwordless login flow."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"One-time password (OTP) code the user received via SMS.","type":"text"}],"type":"paragraph"}],"name":"code"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"audience"},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"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","syntax":"swift"},{"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":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp","type":"codeVoice"},{"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","type":"aside","style":"note"}]}],"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"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","title":"Error Responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","titleInlineContent":[{"type":"text","text":"Error Responses"}],"type":"link"},"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":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/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."}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","type":"topic","kind":"symbol","required":true,"role":"symbol","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"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"type":"topic","title":"login(phoneNumber:code:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","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."}],"kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"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","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"type":"link"},"https://auth0.com/docs/api/authentication#authenticate-user":{"type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]}}} \ 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 122f1950..1a2f22ce 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 @@ -{"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"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(phonenumber:code:audience:scope:)-8kbii"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"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"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"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"},{"text":" = defaultScope) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Phone number the user used to start the passwordless login flow.","type":"text"}],"type":"paragraph"}],"name":"phoneNumber"},{"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":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}]},{"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":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}]},{"content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"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)\")"," }"," }"]},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"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"},{"name":"Requires","type":"aside","style":"note","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","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true},{"type":"text","text":" for more information."}],"type":"paragraph"}]}],"kind":"content"}],"metadata":{"title":"login(phoneNumber:code:audience:scope:)","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","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"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"symbolKind":"method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth014AuthenticationPAAE5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF"},"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."}],"sections":[],"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"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","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":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"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","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"login(phoneNumber:code:audience:scope:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","type":"topic","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."}]},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"title":"Error Responses","type":"link","titleInlineContent":[{"type":"text","text":"Error Responses"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-38nv0":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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"},{"kind":"text","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"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"login(phoneNumber:code:audience:scope:)","defaultImplementations":1,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","required":true,"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","type":"topic","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."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#authenticate-user":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user"},"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","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"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","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]}}} \ No newline at end of file +{"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":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"],"title":"Related Documentation"}],"metadata":{"extendedModule":"Auth0","symbolKind":"method","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"},{"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"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationPAAE5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","roleHeading":"Instance Method","title":"login(phoneNumber:code:audience:scope:)","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" = defaultScope) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","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":">"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Phone number the user used to start the passwordless login flow."}]}],"name":"phoneNumber"},{"name":"code","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via SMS."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"audience"},{"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"}]}]}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"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)\")"," }"," }"]},{"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(phoneNumber: \"+12025550135\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]},{"type":"aside","style":"note","name":"Requires","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"}]}]}]}],"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"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"type":"topic","title":"login(phoneNumber:code:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","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."}],"kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"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","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/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."}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","type":"topic","kind":"symbol","required":true,"role":"symbol","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"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","type":"link","title":"Error Responses","titleInlineContent":[{"type":"text","text":"Error Responses"}]},"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/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/api/authentication#authenticate-user":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]}}} \ 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 d989a773..61cebff2 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","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"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"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","modules":[{"name":"Auth0"}],"role":"symbol","required":true,"title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","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":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"realmOrConnection","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"realm"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/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":"usernameOrEmail"},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Domain of the realm or connection name."}]}],"name":"realmOrConnection"},{"name":"audience","content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values.","type":"text"}]}],"name":"scope"}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"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)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"syntax":"swift","type":"codeListing","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","name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm","type":"codeVoice"},{"text":" grant. 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."}]}]}],"kind":"content"}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"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":">"}],"kind":"symbol","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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"kind":"symbol","abstract":[{"text":"Logs in a user using a username and password with a realm or connection.","type":"text"}],"defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","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"}],"title":"our documentation"},"https://auth0.com/docs/api/authentication":{"identifier":"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"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w"]}],"metadata":{"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","required":true,"modules":[{"name":"Auth0"}],"title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","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"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"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":">"}],"role":"symbol","symbolKind":"method"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"usernameOrEmail","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"username","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"realm","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"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"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Username or email of the user.","type":"text"}]}],"name":"usernameOrEmail"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}],"name":"password"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Domain of the realm or connection name.","type":"text"}]}],"name":"realmOrConnection"},{"content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}]}],"name":"audience"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}]}],"name":"scope"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}]},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"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)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"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) }"]},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm"},{"text":" grant. Check","type":"text"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"reference","isActive":true},{"text":" for more information.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq"],"title":"Authentication Implementations"}],"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/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"usernameOrEmail","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"realmOrConnection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","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":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","role":"symbol","kind":"symbol","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","abstract":[{"text":"Logs in a user using a username and password with a realm or connection.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","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"}],"title":"our documentation"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"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/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","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":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","defaultImplementations":1,"role":"symbol","kind":"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."}],"type":"topic","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"}}} \ 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 f0f82cb8..6cee12ca 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 @@ -{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"usernameOrEmail","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"username"},{"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":"realmOrConnection"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"realm"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" = defaultScope) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"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\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username or email of the user."}]}],"name":"usernameOrEmail"},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password of the user."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Domain of the realm or connection name.","type":"text"}]}],"name":"realmOrConnection"},{"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"}]}]}],"kind":"parameters"},{"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":[{"text":"Usage","anchor":"Usage","level":2,"type":"heading"},{"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","syntax":"swift"},{"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(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","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm","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"},{"text":" for more information.","type":"text"}]}],"style":"note"}],"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(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w"]]},"metadata":{"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","role":"symbol","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"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":">"}],"symbolKind":"method","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"kind":"symbol","abstract":[{"text":"Logs in a user using a username and password with a realm or connection.","type":"text"}],"defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"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"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"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":">"}],"kind":"symbol","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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","extendedModule":"Auth0","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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"},{"text":"<","kind":"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"}],"title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","externalID":"s:5Auth014AuthenticationPAAE5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","roleHeading":"Instance Method"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"text":" ","kind":"text"},{"text":"username","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"kind":"text","text":" "},{"text":"realm","kind":"internalParam"},{"kind":"text","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":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" = defaultScope) -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/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"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"usernameOrEmail","content":[{"inlineContent":[{"text":"Username or email of the user.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}],"name":"password"},{"name":"realmOrConnection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Domain of the realm or connection name."}]}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}],"type":"paragraph"}],"name":"scope"}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"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","syntax":"swift"},{"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) }"],"syntax":"swift","type":"codeListing"},{"name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm"},{"text":" grant. Check","type":"text"},{"type":"text","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","type":"aside"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"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"]]},"identifier":{"interfaceLanguage":"swift","url":"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."}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"usernameOrEmail","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"realmOrConnection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","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":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","role":"symbol","kind":"symbol","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","abstract":[{"text":"Logs in a user using a username and password with a realm or connection.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"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","title":"our documentation","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"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","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","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":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","defaultImplementations":1,"role":"symbol","kind":"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."}],"type":"topic","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w"}}} \ 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 3d7f5fce..2763e4cf 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 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"role":"symbol","externalID":"s:5Auth014AuthenticationP5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","title":"login(withOOBCode:mfaToken:bindingCode:)","modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","interfaceLanguage":"swift"},"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"],"title":"Related Documentation"}],"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"text":" ","type":"text"},{"type":"text","text":"or voice)."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":" "},{"text":"oobCode","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","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"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}]}]},{"parameters":[{"name":"oobCode","content":[{"inlineContent":[{"text":"The OOB code received from the challenge request.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"text":" error due to MFA requirement.","type":"text"}]}],"name":"mfaToken"},{"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."}]}],"name":"bindingCode"}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"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"},{"name":"Requires","type":"aside","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob","type":"codeVoice"},{"text":" grant. 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":"paragraph"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","defaultImplementations":1,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","required":true,"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","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":" "},{"text":"or voice).","type":"text"}]},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"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"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","type":"topic","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)."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"kind":"symbol","title":"isMultifactorRequired"},"https://auth0.com/docs/api/authentication#verify-with-out-of-band-oob-":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","title":"Authentication API Endpoint","type":"link"},"https://auth0.com/docs/api/authentication":{"identifier":"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"}}} \ 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":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"oobCode"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The OOB code received from the challenge request."}]}],"name":"oobCode"},{"name":"mfaToken","content":[{"type":"paragraph","inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"reference"},{"text":" error due to MFA requirement.","type":"text"}]}]},{"name":"bindingCode","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"}]}]}],"kind":"parameters"},{"content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"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","syntax":"swift"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob"},{"type":"text","text":" grant. Check"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true,"type":"reference"},{"type":"text","text":" for more information."}]}],"name":"Requires","type":"aside"}]}],"metadata":{"role":"symbol","symbolKind":"method","externalID":"s:5Auth014AuthenticationP5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","modules":[{"name":"Auth0"}],"required":true,"title":"login(withOOBCode:mfaToken:bindingCode:)","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"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"]}],"abstract":[{"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).","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","interfaceLanguage":"swift"},"sections":[],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"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"},"https://auth0.com/docs/api/authentication":{"type":"link","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"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#verify-with-out-of-band-oob-":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"defaultImplementations":1,"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"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"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"title":"login(withOOBCode:mfaToken:bindingCode:)","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"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","title":"isMultifactorRequired","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"role":"symbol","kind":"symbol","type":"topic","url":"\/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"},{"text":" ","type":"text"},{"type":"text","text":"or voice)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"}}} \ 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 4d67e26b..e7ede6d7 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 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"kind":"text","text":" "},{"kind":"internalParam","text":"oobCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? = nil) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","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":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]}]},{"parameters":[{"name":"oobCode","content":[{"inlineContent":[{"text":"The OOB code received from the challenge request.","type":"text"}],"type":"paragraph"}]},{"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"}]},{"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":"parameters"},{"content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"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","syntax":"swift"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob","type":"codeVoice"},{"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."}]}],"type":"aside","style":"note"}]}],"metadata":{"title":"login(withOOBCode:mfaToken:bindingCode:)","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","role":"symbol","symbolKind":"method","roleHeading":"Instance Method","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"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","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"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"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":[],"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"}],"kind":"symbol","references":{"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/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"kind":"symbol","title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"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"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","type":"topic","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)."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","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","titleInlineContent":[{"type":"text","text":"our documentation"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","defaultImplementations":1,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","required":true,"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","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":" "},{"text":"or voice).","type":"text"}]},"https://auth0.com/docs/api/authentication#verify-with-out-of-band-oob-":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"kind":"symbol","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"]]},"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"text":" ","type":"text"},{"type":"text","text":"or voice)."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":" "},{"text":"oobCode","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil) -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","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","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"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":[{"text":"Token returned when authentication fails with an ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"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":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"inlineContent":[{"text":"A 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(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)\")"," }"," }"]},{"name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob"},{"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":"aside"}],"kind":"content"}],"metadata":{"role":"symbol","extendedModule":"Auth0","symbolKind":"method","externalID":"s:5Auth014AuthenticationPAAE5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","modules":[{"name":"Auth0"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withOOBCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"bindingCode","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"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"defaultImplementations":1,"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"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"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"title":"login(withOOBCode:mfaToken:bindingCode:)","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"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"role":"symbol","kind":"symbol","type":"topic","url":"\/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"},{"text":" ","type":"text"},{"type":"text","text":"or voice)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"},"https://auth0.com/docs/api/authentication#verify-with-out-of-band-oob-":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"titleInlineContent":[{"type":"text","text":"our documentation"}],"title":"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/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"https://auth0.com/docs/api/authentication":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","title":"isMultifactorRequired","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}]}}} \ 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 6c142efe..87e4a8bd 100644 --- a/docs/data/documentation/auth0/authentication/login(withotp:mfatoken:).json +++ b/docs/data/documentation/auth0/authentication/login(withotp:mfatoken:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOTP","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"otp"},{"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"},{"kind":"text","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","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"otp","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password supplied by a MFA authenticator."}]}]},{"content":[{"inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"reference"},{"type":"text","text":" error due to MFA requirement."}],"type":"paragraph"}],"name":"mfaToken"}]},{"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":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"syntax":"swift","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)\")"," }"," }"]},{"type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-otp"},{"type":"text","text":" grant. 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."}]}],"style":"note"}],"kind":"content"}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"required":true,"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOTP","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"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":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}],"title":"login(withOTP:mfaToken:)","externalID":"s:5Auth014AuthenticationP5login7withOTP8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-one-time-password-otp-"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)"},"kind":"symbol","abstract":[{"text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP).","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"kind":"symbol","title":"isMultifactorRequired"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","titleInlineContent":[{"type":"text","text":"our documentation"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"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","url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-one-time-password-otp-","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOTP","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","type":"topic","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"required":true,"kind":"symbol","title":"login(withOTP:mfaToken:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-one-time-password-otp-"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)"]}],"metadata":{"required":true,"roleHeading":"Instance Method","title":"login(withOTP:mfaToken:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP5login7withOTP8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOTP"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOTP","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"otp"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","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","text":"Request","kind":"typeIdentifier","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"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"otp","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password supplied by a MFA authenticator."}]}]},{"name":"mfaToken","content":[{"type":"paragraph","inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"text":" error due to MFA requirement.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"syntax":"swift","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)\")"," }"," }"]},{"name":"Requires","type":"aside","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-otp"},{"text":" grant. Check","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true,"type":"reference"},{"type":"text","text":" for more information."}],"type":"paragraph"}]}],"kind":"content"}],"references":{"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","title":"login(withOTP:mfaToken:)","abstract":[{"text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP).","type":"text"}],"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOTP","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","title":"isMultifactorRequired","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#verify-with-one-time-password-otp-":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"title":"Authentication API Endpoint","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-","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"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"}}} \ 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 06bfa838..d1954f7b 100644 --- a/docs/data/documentation/auth0/authentication/login(withrecoverycode:mfatoken:).json +++ b/docs/data/documentation/auth0/authentication/login(withrecoverycode:mfatoken:).json @@ -1 +1 @@ -{"metadata":{"required":true,"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5login16withRecoveryCode8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withRecoveryCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","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","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"symbolKind":"method","title":"login(withRecoveryCode:mfaToken:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"recoveryCode"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","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","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}]}]},{"parameters":[{"name":"recoveryCode","content":[{"type":"paragraph","inlineContent":[{"text":"Recovery code provided by the user.","type":"text"}]}]},{"name":"mfaToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","isActive":true,"type":"reference"},{"text":" error due to MFA requirement.","type":"text"}]}]}],"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":[{"type":"text","text":"recovery code"}]},{"type":"text","text":", which the"},{"text":" ","type":"text"},{"text":"application must display to the user to be stored securely for future use.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"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":"codeListing","syntax":"swift"},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-recovery-code"},{"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"}],"type":"paragraph"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","interfaceLanguage":"swift"},"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"},{"text":" ","type":"text"},{"type":"text","text":"it due to connectivity issues."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"kind":"symbol","title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication#verify-with-recovery-code":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a recovery code."},{"type":"text","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","type":"text"},{"type":"text","text":" "},{"text":"it due to connectivity issues.","type":"text"}],"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"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":">"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","title":"login(withRecoveryCode:mfaToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)"},"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"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"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"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/credentials\/recoverycode","title":"recoveryCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","interfaceLanguage":"swift"},"metadata":{"title":"login(withRecoveryCode:mfaToken:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRecoveryCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","required":true,"externalID":"s:5Auth014AuthenticationP5login16withRecoveryCode8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"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},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withRecoveryCode","kind":"externalParam"},{"kind":"text","text":" "},{"text":"recoveryCode","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"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"},{"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":", "},{"kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]}]},{"parameters":[{"name":"recoveryCode","content":[{"inlineContent":[{"type":"text","text":"Recovery code provided by the user."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"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"},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials. Might include a "},{"type":"strong","inlineContent":[{"type":"text","text":"recovery code"}]},{"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"}]},{"content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","type":"codeListing","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)\")"," }"," }"]},{"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"}]}],"type":"aside","style":"note","name":"Requires"}],"kind":"content"}],"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"},{"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"}],"references":{"https://auth0.com/docs/get-started/applications/application-grant-types":{"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","title":"our documentation"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","title":"isMultifactorRequired","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"title":"login(withRecoveryCode:mfaToken:)","type":"topic","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a recovery code."},{"type":"text","text":" "},{"text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to","type":"text"},{"text":" ","type":"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"},{"type":"text","text":"it due to connectivity issues."}],"url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRecoveryCode"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"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","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"kind":"symbol","required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#verify-with-recovery-code":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"title":"recoveryCode","type":"topic","abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"url":"\/documentation\/auth0\/credentials\/recoverycode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"recoveryCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"kind":"symbol","role":"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 9b77dd5e..d2e8a7b9 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 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","interfaceLanguage":"swift"},"metadata":{"symbolKind":"method","required":true,"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","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":">"}],"externalID":"s:5Auth014AuthenticationP21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","role":"symbol","modules":[{"name":"Auth0"}]},"sections":[],"abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8"],"title":"Authentication Implementations"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"username"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","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"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"username","content":[{"inlineContent":[{"type":"text","text":"Username or email of the user."}],"type":"paragraph"}]},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values.","type":"text"}]}]}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"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"},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"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","syntax":"swift"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","references":{"https://auth0.com/docs/api/authentication":{"identifier":"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"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"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","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","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"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","required":true,"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"loginDefaultDirectory"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","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"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","defaultImplementations":1,"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":" "},{"text":"username","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"username","content":[{"type":"paragraph","inlineContent":[{"text":"Username or email of the user.","type":"text"}]}]},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}],"type":"paragraph"}],"name":"audience"},{"name":"scope","content":[{"inlineContent":[{"text":"Space-separated list of requested scope values.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Usage","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"},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"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) }"],"syntax":"swift","type":"codeListing"}]}],"abstract":[{"text":"Logs in a user using a username and password in the default directory.","type":"text"}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["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"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn"},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn"]}],"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"required":true,"externalID":"s:5Auth014AuthenticationP21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"defaultImplementations":1,"required":true,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","type":"topic","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","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"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"kind":"symbol","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","type":"topic","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"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"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]}}} \ 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 e1f9cf7e..b1216a2f 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 @@ -{"abstract":[{"text":"Logs in a user using a username and password in the default directory.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","interfaceLanguage":"swift"},"metadata":{"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","symbolKind":"method","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"loginDefaultDirectory"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"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"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"username"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"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"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username or email of the user."}]}],"name":"username"},{"name":"password","content":[{"inlineContent":[{"text":"Password of the user.","type":"text"}],"type":"paragraph"}]},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}]}],"name":"scope"}]},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"content":[{"level":2,"anchor":"Usage","type":"heading","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","doc:\/\/com.auth0.Auth0\/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","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","required":true,"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"loginDefaultDirectory"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","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"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","defaultImplementations":1,"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"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","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","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"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"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":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","interfaceLanguage":"swift"},"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"}],"metadata":{"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","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","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":" "},{"text":"username","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" = defaultScope) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"username","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"}]}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}]}]}]},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"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"},{"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) }"],"syntax":"swift"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"kind":"symbol","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","type":"topic","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"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"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"defaultImplementations":1,"required":true,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","type":"topic","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","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"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"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 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 2f7ce7ec..7242cda2 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 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]?, "},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"kind":"text","text":"<"},{"text":"Challenge","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"text":" error due to MFA requirement.","type":"text"}]}],"name":"mfaToken"},{"name":"types","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 "},{"code":"otp","type":"codeVoice"},{"type":"text","text":". Excluding this parameter means that your application accepts all supported challenge types."}],"type":"paragraph"}]},{"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"}],"name":"authenticatorId"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a multi-factor challenge."}]}],"kind":"content"},{"content":[{"type":"heading","anchor":"Usage","level":2,"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":[{"type":"text","text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"code":"otp","type":"codeVoice"},{"type":"text","text":": for one-time password (OTP)"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"oob"},{"type":"text","text":": for SMS\/voice messages or out-of-band (OOB)"}]}]}]}],"kind":"content"}],"metadata":{"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","required":true,"externalID":"s:5Auth014AuthenticationP20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"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"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier","text":"Challenge"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"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"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","interfaceLanguage":"swift"},"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct"]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"],"title":"Related Documentation"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"kind":"symbol","title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","type":"topic","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]?, "},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"defaultImplementations":1,"abstract":[{"type":"text","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."}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication#challenge-request":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"text":"authenticatorId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier","text":"Challenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"abstract":[{"type":"text","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."}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth014AuthenticationP20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Challenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"symbolKind":"method","required":true},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","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."}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"mfaToken","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":"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":[{"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"}],"name":"authenticatorId"}]},{"content":[{"type":"heading","text":"Return Value","level":2,"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","type":"heading","level":2},{"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"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"codeVoice","code":"otp"},{"type":"text","text":": for one-time password (OTP)"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"code":"oob","type":"codeVoice"},{"type":"text","text":": for SMS\/voice messages or out-of-band (OOB)"}]}]}]}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"kind":"symbol","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"authenticatorId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier","text":"Challenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","required":true,"defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","title":"isMultifactorRequired","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#challenge-request":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","url":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"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/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"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"},{"type":"text","text":" "},{"text":"application and user.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"url":"\/documentation\/auth0\/challenge","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"}}} \ 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 fc4ac32f..77cad509 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 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct"},"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"]]},"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"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"],"title":"Related Documentation"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]? = nil, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"typeIdentifier","text":"Challenge"},{"text":", ","kind":"text"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"mfaToken","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":"types","content":[{"inlineContent":[{"text":"A list of the challenges types accepted by your application. Accepted challenge types are ","type":"text"},{"type":"codeVoice","code":"oob"},{"text":" or ","type":"text"},{"code":"otp","type":"codeVoice"},{"type":"text","text":". Excluding this parameter means that your application accepts all supported challenge types."}],"type":"paragraph"}]},{"name":"authenticatorId","content":[{"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."}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"A request that will yield a multi-factor challenge."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"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":[{"type":"text","text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"code":"otp","type":"codeVoice"},{"type":"text","text":": for one-time password (OTP)"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"code":"oob","type":"codeVoice"},{"type":"text","text":": for SMS\/voice messages or out-of-band (OOB)"}]}]}],"type":"unorderedList"}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct"]}],"metadata":{"role":"symbol","extendedModule":"Auth0","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationPAAE20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"text":"authenticatorId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier","text":"Challenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"abstract":[{"type":"text","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."}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","type":"topic","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]?, "},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"defaultImplementations":1,"abstract":[{"type":"text","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."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"kind":"symbol","title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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"},"https://auth0.com/docs/api/authentication":{"identifier":"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"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"types"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]? = nil, "},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier","text":"Challenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"mfaToken","content":[{"type":"paragraph","inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","isActive":true},{"type":"text","text":" error due to MFA requirement."}]}]},{"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 "},{"code":"otp","type":"codeVoice"},{"text":". Excluding this parameter means that your application accepts all supported challenge types.","type":"text"}],"type":"paragraph"}],"name":"types"},{"name":"authenticatorId","content":[{"type":"paragraph","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"}]}]}]},{"content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a multi-factor challenge."}]}],"kind":"content"},{"content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"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":[{"text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:","type":"text"}]},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"otp"},{"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"}],"kind":"content"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"]}],"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"]]},"sections":[],"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."}],"metadata":{"role":"symbol","symbolKind":"method","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationPAAE20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"url":"\/documentation\/auth0\/challenge","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"kind":"symbol","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"authenticatorId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier","text":"Challenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","required":true,"defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"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"},{"type":"text","text":" "},{"text":"application and user.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","title":"isMultifactorRequired","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}]},"https://auth0.com/docs/api/authentication#challenge-request":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]}}} \ 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 b99c5fef..037829b0 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 @@ -{"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":" "},{"kind":"internalParam","text":"refreshToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"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"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The refresh token."}]}],"name":"refreshToken"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of scope values to request. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":", which will ask for the same scopes that were originally requested on login.","type":"text"}]}],"name":"scope"}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"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"},{"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"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","sections":[],"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"}],"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"metadata":{"role":"symbol","required":true,"symbolKind":"method","title":"renew(withRefreshToken:scope:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","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"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5renew16withRefreshToken5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgtF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-8vkbb":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","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":"renew(withRefreshToken:scope:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"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":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"required":true,"title":"renew(withRefreshToken:scope:)","role":"symbol","type":"topic","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"text":"withRefreshToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"internalParam"},{"kind":"text","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"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/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":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The refresh token.","type":"text"}]}],"name":"refreshToken"},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of scope values to request. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":", which will ask for the same scopes that were originally requested on login.","type":"text"}]}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"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},{"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":[{"type":"text","text":"You can get a downscoped access token by requesting fewer scopes than were originally requested on login:"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," scope: \"openid offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"}]}],"metadata":{"role":"symbol","symbolKind":"method","externalID":"s:5Auth014AuthenticationP5renew16withRefreshToken5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgtF","modules":[{"name":"Auth0"}],"required":true,"title":"renew(withRefreshToken:scope:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","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":", "},{"text":"scope","kind":"externalParam"},{"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","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"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"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg"]}],"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","interfaceLanguage":"swift"},"sections":[],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"https://auth0.com/docs/api/authentication":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"title":"renew(withRefreshToken:scope:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","role":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"text":"withRefreshToken","kind":"externalParam"},{"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"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"type":"topic","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-8vkbb":{"title":"renew(withRefreshToken:scope:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","role":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","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"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"https://auth0.com/docs/api/authentication#refresh-token":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"}}} \ 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 e0717324..1bf5a3f4 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 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","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"]}],"kind":"symbol","metadata":{"title":"renew(withRefreshToken:scope:)","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationPAAE5renew16withRefreshToken5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgtF","extendedModule":"Auth0","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"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"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"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"]]},"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"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":" "},{"kind":"internalParam","text":"refreshToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? = nil) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"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":[{"inlineContent":[{"type":"text","text":"The refresh token."}],"type":"paragraph"}],"name":"refreshToken"},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request. Defaults to "},{"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":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"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":"codeListing"},{"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"}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"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":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"required":true,"title":"renew(withRefreshToken:scope:)","role":"symbol","type":"topic","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-8vkbb":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","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":"renew(withRefreshToken:scope:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"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","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]}}} \ No newline at end of file +{"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":{"minor":3,"major":0,"patch":0},"kind":"symbol","sections":[],"metadata":{"extendedModule":"Auth0","roleHeading":"Instance Method","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationPAAE5renew16withRefreshToken5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgtF","title":"renew(withRefreshToken:scope:)","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"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"]]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"text":"withRefreshToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"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 "},{"code":"nil","type":"codeVoice"},{"text":", which will ask for the same scopes that were originally requested on login.","type":"text"}]}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"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":[{"type":"text","text":"You can get a downscoped access token by requesting fewer scopes than were originally requested on login:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," scope: \"openid offline_access\")"," .start { print($0) }"]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-8vkbb":{"title":"renew(withRefreshToken:scope:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","role":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","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"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"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/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"title":"renew(withRefreshToken:scope:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","role":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"text":"withRefreshToken","kind":"externalParam"},{"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"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"type":"topic","defaultImplementations":1},"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"}}} \ 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 54da4fa9..da514abf 100644 --- a/docs/data/documentation/auth0/authentication/resetpassword(email:connection:).json +++ b/docs/data/documentation/auth0/authentication/resetpassword(email:connection:).json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"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"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"required":true,"role":"symbol","title":"resetPassword(email:connection:)","externalID":"s:5Auth014AuthenticationP13resetPassword5email10connectionAA7RequestVyytAA0B5ErrorVGSS_SStF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#change-password"],"title":"Related Documentation"}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)"},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"resetPassword"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Email of the database user."}]}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the database connection."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for resetting the password."}]}]},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .resetPassword(email: \"support@auth0.com\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/resetpassword(email:connection:)"]}],"abstract":[{"type":"text","text":"Resets the password of a database user."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"title":"resetPassword(email:connection:)","url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","required":true,"type":"topic","abstract":[{"type":"text","text":"Resets the password of a database user."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication#change-password":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#change-password","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#change-password"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/resetpassword(email:connection:)"]}],"kind":"symbol","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"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#change-password"],"title":"Related Documentation"}],"sections":[],"metadata":{"externalID":"s:5Auth014AuthenticationP13resetPassword5email10connectionAA7RequestVyytAA0B5ErrorVGSS_SStF","required":true,"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","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"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}],"title":"resetPassword(email:connection:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Resets the password of a database user.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"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"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Email of the database user."}],"type":"paragraph"}],"name":"email"},{"name":"connection","content":[{"inlineContent":[{"text":"Name of the database connection.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"A request for resetting the password.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .resetPassword(email: \"support@auth0.com\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","type":"topic","abstract":[{"text":"Resets the password of a database user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","title":"resetPassword(email:connection:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"resetPassword"},{"text":"(","kind":"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","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"https://auth0.com/docs/api/authentication#change-password":{"title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#change-password","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#change-password"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","url":"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/revoke(refreshtoken:).json b/docs/data/documentation/auth0/authentication/revoke(refreshtoken:).json index baf4ab48..7961b542 100644 --- a/docs/data/documentation/auth0/authentication/revoke(refreshtoken:).json +++ b/docs/data/documentation/auth0/authentication/revoke(refreshtoken:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/revoke(refreshtoken:)"]}],"kind":"symbol","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"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke"],"title":"Related Documentation"}],"sections":[],"metadata":{"externalID":"s:5Auth014AuthenticationP6revoke12refreshTokenAA7RequestVyytAA0B5ErrorVGSS_tF","required":true,"symbolKind":"method","roleHeading":"Instance Method","role":"symbol","modules":[{"name":"Auth0"}],"title":"revoke(refreshToken:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"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"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"refreshToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"refreshToken","content":[{"inlineContent":[{"text":"The refresh token to revoke.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"A request for revoking the refresh token."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .revoke(refreshToken: credentials.refreshToken)"," .start { print($0) }"],"type":"codeListing"}],"kind":"content"}],"abstract":[{"text":"Revokes a user’s refresh token by performing a request to the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"references":{"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"text":"refreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"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."}],"title":"revoke(refreshToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication#post-oauth-revoke":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke","title":"Error Responses","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke","titleInlineContent":[{"text":"Error Responses","type":"text"}]},"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/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authentication\/revoke(refreshtoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","required":true,"symbolKind":"method","externalID":"s:5Auth014AuthenticationP6revoke12refreshTokenAA7RequestVyytAA0B5ErrorVGSS_tF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"refreshToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"revoke(refreshToken:)","roleHeading":"Instance Method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"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","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"refreshToken","content":[{"type":"paragraph","inlineContent":[{"text":"The refresh token to revoke.","type":"text"}]}]}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for revoking the refresh token."}]}]},{"content":[{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .revoke(refreshToken: credentials.refreshToken)"," .start { print($0) }"]}],"kind":"content"}],"sections":[],"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."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"abstract":[{"text":"Revokes a user’s refresh token by performing a request to the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"refreshToken","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"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"revoke(refreshToken:)","url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication":{"type":"link","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"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/api/authentication#post-oauth-revoke":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke","titleInlineContent":[{"type":"text","text":"Error Responses"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke","title":"Error Responses"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint"}}} \ 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 7f9ce3bd..6238ff0e 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":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#signup"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y"]}],"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":{"required":true,"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","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":"]?, "},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationP6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF"},"abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"]}],"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"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"},{"text":"rootAttributes","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Email for the new user."}]}]},{"name":"username","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username for the new user (if the connection requires a username). Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password for the new user."}]}],"name":"password"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection where the user will be created (database connection)."}]}],"name":"connection"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional user metadata parameters that will be added to the newly created user."}]}],"name":"userMetadata"},{"name":"rootAttributes","content":[{"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."}],"type":"paragraph"}]}]},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"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)."}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"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","type":"codeListing","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) }"]},{"inlineContent":[{"text":"If the database connection requires a username:","type":"text"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","kind":"symbol","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"text":"rootAttributes","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"DatabaseUser","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"abstract":[{"text":"Creates a user in a database connection.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","defaultImplementations":1,"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"rootAttributes"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"text":"Creates a user in a database connection.","type":"text"}]},"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","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"kind":"symbol","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","role":"symbol","title":"DatabaseUser","url":"\/documentation\/auth0\/databaseuser","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"DatabaseUser","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#signup":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#signup","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#signup","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","interfaceLanguage":"swift"},"metadata":{"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","role":"symbol","required":true,"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF","symbolKind":"method"},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"],"title":"Authentication Implementations"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#signup"],"title":"Related Documentation"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"signup"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","text":"DatabaseUser","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Email for the new user."}]}],"name":"email"},{"name":"username","content":[{"inlineContent":[{"type":"text","text":"Username for the new user (if the connection requires a username). Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"text":"Password for the new user.","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Name of the connection where the user will be created (database connection)."}],"type":"paragraph"}],"name":"connection"},{"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":[{"type":"paragraph","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"}]}]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"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":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"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"},{"type":"codeListing","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"},{"inlineContent":[{"text":"If the database connection requires a username:","type":"text"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"signup"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"text":": ","kind":"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":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"userMetadata","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":"rootAttributes"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","role":"symbol","defaultImplementations":1,"required":true,"type":"topic","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/api/authentication#signup":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#signup","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#signup"},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"role":"symbol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"rootAttributes"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","role":"symbol","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Creates a user in a database connection."}]}}} \ 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 9d4a43b3..f31a7f23 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 @@ -{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#signup"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"? = nil, ","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"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]? = nil, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]? = nil) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"DatabaseUser","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier"},{"text":", ","kind":"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":[{"text":"Email for the new user.","type":"text"}],"type":"paragraph"}]},{"name":"username","content":[{"type":"paragraph","inlineContent":[{"text":"Username for the new user (if the connection requires a username). Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}]},{"name":"password","content":[{"inlineContent":[{"type":"text","text":"Password for the new user."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Name of the connection where the user will be created (database connection)."}],"type":"paragraph"}],"name":"connection"},{"name":"userMetadata","content":[{"inlineContent":[{"text":"Additional user metadata parameters that will be added to the newly created user.","type":"text"}],"type":"paragraph"}]},{"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,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield a newly created database user (just the email, username, and email verified flag)."}],"type":"paragraph"}]},{"content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"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"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"]}],"kind":"content"}],"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"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"},{"kind":"text","text":"]?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol","externalID":"s:5Auth014AuthenticationPAAE6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF","modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","extendedModule":"Auth0"},"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"]]},"abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://auth0.com/docs/api/authentication#signup":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#signup","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#signup","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","kind":"symbol","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"text":"rootAttributes","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"DatabaseUser","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"abstract":[{"text":"Creates a user in a database connection.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"kind":"symbol","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","role":"symbol","title":"DatabaseUser","url":"\/documentation\/auth0\/databaseuser","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"DatabaseUser","kind":"identifier"}]},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","defaultImplementations":1,"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"rootAttributes"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"text":"Creates a user in a database connection.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"sections":[],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#signup"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]? = nil, "},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]? = nil) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"DatabaseUser","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera","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":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"text":"Email for the new user.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username for the new user (if the connection requires a username). Defaults to "},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"username"},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password for the new user."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection where the user will be created (database connection)."}]}],"name":"connection"},{"name":"userMetadata","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional user metadata parameters that will be added to the newly created user."}]}]},{"content":[{"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."}],"type":"paragraph"}],"name":"rootAttributes"}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"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":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"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":[{"type":"text","text":"You can also add additional metadata when creating the user:"}],"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) }"],"type":"codeListing","syntax":"swift"},{"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"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","interfaceLanguage":"swift"},"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":{"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"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"userMetadata","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":"rootAttributes"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationPAAE6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","extendedModule":"Auth0","role":"symbol","symbolKind":"method","roleHeading":"Instance Method"},"kind":"symbol","references":{"https://auth0.com/docs/api/authentication#signup":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#signup","url":"https:\/\/auth0.com\/docs\/api\/authentication#signup"},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"role":"symbol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"rootAttributes"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","role":"symbol","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Creates a user in a database connection."}]},"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/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"signup"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"text":": ","kind":"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":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"userMetadata","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":"rootAttributes"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","role":"symbol","defaultImplementations":1,"required":true,"type":"topic","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 19ebaa17..aaa9ddc2 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 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe"]}],"sections":[],"kind":"symbol","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."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"],"title":"Related Documentation"}],"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\/startPasswordless(email:type:connection:)-6xl8p"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Email where to send the code or link.","type":"text"}],"type":"paragraph"}],"name":"email"},{"name":"type","content":[{"inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘email’.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"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},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"]},{"inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"name":"Requires","content":[{"type":"paragraph","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"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}]}],"style":"note","type":"aside"}],"kind":"content"}],"metadata":{"required":true,"roleHeading":"Instance Method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","modules":[{"name":"Auth0"}],"title":"startPasswordless(email:type:connection:)","symbolKind":"method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-56xbe":{"required":true,"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","kind":"symbol","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."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"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":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","title":"startPasswordless(email:type:connection:)","defaultImplementations":1},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"type":"link","title":"Error Responses","identifier":"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"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","kind":"symbol","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."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"text":"connection","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":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","title":"startPasswordless(email:type:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"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","url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","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"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth014AuthenticationP17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","title":"startPasswordless(email:type:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"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"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","required":true},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p"],"title":"Authentication Implementations"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"]}],"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe"],"traits":[{"interfaceLanguage":"swift"}]}],"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"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"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","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","preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"email","content":[{"inlineContent":[{"text":"Email where to send the code or link.","type":"text"}],"type":"paragraph"}]},{"name":"type","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}]}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘email’."}],"type":"paragraph"}]}]},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"A request for starting the passwordless flow.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"If you have configured iOS Universal Links:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"],"type":"codeListing"},{"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"}],"style":"note","type":"aside","name":"Requires"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"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":[{"text":"Error Responses","type":"text"}],"type":"link"},"https://auth0.com/docs/api/authentication":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"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"},{"text":"passwordless login flow.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","kind":"symbol","required":true,"role":"symbol","defaultImplementations":1,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"startPasswordless(email:type:connection:)","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/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"},{"type":"text","text":" "},{"type":"text","text":"passwordless login flow."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"startPasswordless(email:type:connection:)","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#get-code-or-link":{"url":"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":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 5be2b617..0566ac35 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 @@ -{"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"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},{"text":" = .code, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"email\") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Email where to send the code or link.","type":"text"}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"text":"Type of passwordless authentication. Defaults to ‘code’.","type":"text"}],"type":"paragraph"}],"name":"type"},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘email’."}]}]}]},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"text":"A request for starting the passwordless flow.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .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(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"],"syntax":"swift"},{"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"}],"name":"Requires","style":"note","type":"aside"}]}],"kind":"symbol","metadata":{"roleHeading":"Instance Method","title":"startPasswordless(email:type:connection:)","externalID":"s:5Auth014AuthenticationPAAE17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","extendedModule":"Auth0","symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"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/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-56xbe":{"required":true,"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","kind":"symbol","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."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"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":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","title":"startPasswordless(email:type:connection:)","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","kind":"symbol","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."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"text":"connection","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":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","title":"startPasswordless(email:type:connection:)"},"https://auth0.com/docs/api/authentication#get-code-or-link":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link"},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","title":"Error Responses","titleInlineContent":[{"type":"text","text":"Error Responses"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},{"text":" = .code, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"email\") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Email where to send the code or link.","type":"text"}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"text":"Type of passwordless authentication. Defaults to ‘code’.","type":"text"}],"type":"paragraph"}],"name":"type"},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘email’."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"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:"}]},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"],"type":"codeListing"},{"type":"aside","style":"note","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":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}]}],"name":"Requires"}]}],"metadata":{"extendedModule":"Auth0","title":"startPasswordless(email:type:connection:)","modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationPAAE17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"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":">"}]},"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"]]},"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."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p"],"traits":[{"interfaceLanguage":"swift"}]}],"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"}],"references":{"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":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","type":"link","titleInlineContent":[{"type":"text","text":"Error Responses"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","title":"Error Responses"},"doc://com.auth0.Auth0/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"},{"type":"text","text":" "},{"type":"text","text":"passwordless login flow."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"startPasswordless(email:type:connection:)","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication":{"identifier":"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"},"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"},{"text":"passwordless login flow.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","kind":"symbol","required":true,"role":"symbol","defaultImplementations":1,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"startPasswordless(email:type:connection:)","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe"},"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","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"}}} \ 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 f3a96a3b..498457b4 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 @@ -{"kind":"symbol","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":" "},{"text":"login flow.","type":"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"}],"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"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm"]}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","modules":[{"name":"Auth0"}],"title":"startPasswordless(phoneNumber:type:connection:)","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","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":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","extendedModule":"Auth0"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":" = .code, "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" = \"sms\") -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"text":"Phone number where to send the SMS with the code or link.","type":"text"}],"type":"paragraph"}]},{"name":"type","content":[{"type":"paragraph","inlineContent":[{"text":"Type of passwordless authentication. Defaults to ‘code’.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘sms’.","type":"text"}]}],"name":"connection"}]},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A request for starting the passwordless flow.","type":"text"}]}]},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"If you have configured iOS Universal Links:","type":"text"}]},{"code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"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"},{"text":" ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}]}],"style":"note"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","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"},{"type":"text","text":"login flow."}],"type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","title":"startPasswordless(phoneNumber:type:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol","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"},{"type":"text","text":"login flow."}],"defaultImplementations":1,"type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","title":"startPasswordless(phoneNumber:type:connection:)","required":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"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":[{"text":"Error Responses","type":"text"}]},"https://auth0.com/docs/api/authentication#get-code-or-link":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","type":"link","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"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":[{"text":"our documentation","type":"text"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"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"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},{"text":" = .code, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"sms\") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"text":"Phone number where to send the SMS with 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":[{"inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘sms’.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}]}],"kind":"content"},{"content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"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","syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"]},{"name":"Requires","content":[{"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","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true},{"type":"text","text":" for more information."}],"type":"paragraph"}],"style":"note","type":"aside"}],"kind":"content"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/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"]}],"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"]]},"sections":[],"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."}],"metadata":{"role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","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","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"extendedModule":"Auth0","title":"startPasswordless(phoneNumber:type:connection:)","externalID":"s:5Auth014AuthenticationPAAE17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","symbolKind":"method","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"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","type":"link","titleInlineContent":[{"text":"Error Responses","type":"text"}]},"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","title":"our documentation","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","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."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"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","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"startPasswordless(phoneNumber:type:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"kind":"symbol","url":"\/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"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","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"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"startPasswordless(phoneNumber:type:connection:)","defaultImplementations":1,"required":true},"https://auth0.com/docs/api/authentication":{"url":"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"}]},"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","title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]}}} \ 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 98426bda..11d2d66f 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":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","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":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Phone number where to send the SMS with the code or link."}]}]},{"name":"type","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}]}]},{"content":[{"inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘sms’.","type":"text"}],"type":"paragraph"}],"name":"connection"}]},{"kind":"content","content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"A request for starting the passwordless flow.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"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:"}]},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"type":"codeListing"},{"type":"aside","name":"Requires","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":" "},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true,"type":"reference"},{"type":"text","text":" for more information."}]}],"style":"note"}]}],"kind":"symbol","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"]]},"sections":[],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"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"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","role":"symbol","required":true,"symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"startPasswordless(phoneNumber:type:connection:)"},"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"},{"type":"text","text":"login flow."}],"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"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"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","titleInlineContent":[{"text":"Error Responses","type":"text"}],"title":"Error Responses"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","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"},{"type":"text","text":"login flow."}],"type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","title":"startPasswordless(phoneNumber:type:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"https://auth0.com/docs/api/authentication":{"url":"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"},"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","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol","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"},{"type":"text","text":"login flow."}],"defaultImplementations":1,"type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","title":"startPasswordless(phoneNumber:type:connection:)","required":true,"kind":"symbol"},"https://auth0.com/docs/api/authentication#get-code-or-link":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link"}}} \ No newline at end of file +{"kind":"symbol","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"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"text":"Phone number where to send the SMS with the code or link.","type":"text"}],"type":"paragraph"}]},{"name":"type","content":[{"inlineContent":[{"text":"Type of passwordless authentication. Defaults to ‘code’.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘sms’."}],"type":"paragraph"}],"name":"connection"}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A request for starting the passwordless flow.","type":"text"}]}],"kind":"content"},{"content":[{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"]},{"type":"paragraph","inlineContent":[{"text":"If you have configured iOS Universal Links:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"]},{"style":"note","content":[{"type":"paragraph","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":"aside","name":"Requires"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt"]}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm"],"title":"Authentication Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"required":true,"modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"startPasswordless(phoneNumber:type:connection:)","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","symbolKind":"method"},"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."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"kind":"symbol","url":"\/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"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","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"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"startPasswordless(phoneNumber:type:connection:)","defaultImplementations":1,"required":true},"https://auth0.com/docs/api/authentication#get-code-or-link":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","title":"Authentication API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"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":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","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."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"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","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"startPasswordless(phoneNumber:type:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"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"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","title":"Error Responses"},"https://auth0.com/docs/api/authentication":{"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","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]}}} \ 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 8275e8c5..fc7889db 100644 --- a/docs/data/documentation/auth0/authentication/url.json +++ b/docs/data/documentation/auth0/authentication/url.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth014AuthenticationP3url10Foundation3URLVvp","symbolKind":"property","required":true,"modules":[{"name":"Auth0"}],"title":"url","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"kind":"text","text":": "},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}]},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/url"]}],"abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"type":"topic","url":"\/documentation\/auth0\/authentication\/url","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"required":true,"kind":"symbol","title":"url","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/url"]}],"metadata":{"symbolKind":"property","title":"url","externalID":"s:5Auth014AuthenticationP3url10Foundation3URLVvp","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}],"roleHeading":"Instance Property","required":true,"role":"symbol","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"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":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","kind":"symbol","url":"\/documentation\/auth0\/authentication\/url","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"required":true,"title":"url","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"role":"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 5740cc78..253558f1 100644 --- a/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:).json +++ b/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:).json @@ -1 +1 @@ -{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":" "},{"text":"accessToken","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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\/UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"accessToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Access token obtained by authenticating the user."}]}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield user information."}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"syntax":"swift","type":"codeListing","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)\")"," }"," }"]}]}],"metadata":{"externalID":"s:5Auth014AuthenticationP8userInfo15withAccessTokenAA7RequestVyAA04UserD0VAA0B5ErrorVGSS_tF","required":true,"symbolKind":"method","roleHeading":"Instance Method","role":"symbol","modules":[{"name":"Auth0"}],"title":"userInfo(withAccessToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"kind":"text","text":"("},{"text":"withAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"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"}],"references":{"https://auth0.com/docs/api/authentication":{"identifier":"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"},"https://auth0.com/docs/api/authentication#get-user-info":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-user-info","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-user-info"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"userInfo","kind":"identifier"},{"kind":"text","text":"("},{"text":"withAccessToken","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":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"required":true,"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"role":"symbol","title":"userInfo(withAccessToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)","url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP8userInfo15withAccessTokenAA7RequestVyAA04UserD0VAA0B5ErrorVGSS_tF","title":"userInfo(withAccessToken:)","role":"symbol","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"abstract":[{"text":"Returns OIDC standard claims information by performing a request to the ","type":"text"},{"code":"\/userinfo","type":"codeVoice"},{"type":"text","text":" endpoint."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-user-info"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userInfo"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"accessToken","content":[{"inlineContent":[{"type":"text","text":"Access token obtained by authenticating the user."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield user information."}]}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","type":"codeListing","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)\")"," }"," }"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)"},"kind":"symbol","references":{"https://auth0.com/docs/api/authentication#get-user-info":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-user-info","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-user-info","title":"Authentication API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"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","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"text":"withAccessToken","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":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)","abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"text":" endpoint.","type":"text"}],"title":"userInfo(withAccessToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror.json b/docs/data/documentation/auth0/authenticationerror.json index a9b707d1..6dabe03c 100644 --- a/docs/data/documentation/auth0/authenticationerror.json +++ b/docs/data/documentation/auth0/authenticationerror.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)"]},{"title":"Instance Properties","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":"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"],"generated":true}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},"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"}],"sections":[],"metadata":{"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"title":"AuthenticationError","externalID":"s:5Auth019AuthenticationErrorV","role":"symbol","roleHeading":"Structure","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","title":"isInvalidCredentials","type":"topic","abstract":[{"type":"text","text":"When the username and\/or password used for authentication are invalid."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/auth0error\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","title":"isRefreshTokenDeleted","type":"topic","abstract":[{"type":"text","text":"When the credentials renewal fails because the user was deleted."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","role":"symbol"},"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"kind":"symbol","title":"statusCode","type":"topic","abstract":[{"type":"text","text":"HTTP status code of the response."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","url":"\/documentation\/auth0\/authenticationerror\/statuscode","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isInvalidRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isInvalidRefreshToken","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"kind":"symbol","title":"init(info:statusCode:)","type":"topic","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordLeaked","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isPasswordLeaked","type":"topic","abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","title":"LocalizedError Implementations","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","title":"isMultifactorCodeInvalid","type":"topic","abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","title":"isRuleError","type":"topic","abstract":[{"text":"When an Auth0 rule returns an error.","type":"text"},{"text":" ","type":"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":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","title":"isNetworkError","type":"topic","abstract":[{"type":"text","text":"When the request failed due to network issues."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","role":"symbol"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isMultifactorTokenInvalid","type":"topic","abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isLoginRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isLoginRequired","type":"topic","abstract":[{"type":"text","text":"When performing Web Auth login with "},{"type":"codeVoice","code":"prompt: \"none\""},{"type":"text","text":" and the Auth0 session has expired."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","url":"\/documentation\/auth0\/authenticationerror\/isloginrequired","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"kind":"symbol","title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"kind":"symbol","title":"cause","type":"topic","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","url":"\/documentation\/auth0\/authenticationerror\/cause","role":"symbol"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"kind":"article","title":"Equatable Implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","title":"isTooManyAttempts","type":"topic","abstract":[{"text":"When the user is blocked due to too many attempts to log in.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","role":"symbol"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/code","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","title":"code","abstract":[{"type":"text","text":"The code of the error as a string."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isPasswordNotStrongEnough","type":"topic","abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"type":"text","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."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isAccessDenied","type":"topic","abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isMultifactorEnrollRequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required and the user is not enrolled."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","role":"symbol"},"https://auth0.com/docs/api/authentication#standard-error-responses":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","title":"Standard Error Responses","titleInlineContent":[{"type":"text","text":"Standard Error Responses"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","type":"topic","abstract":[{"type":"text","text":"When an additional verification step is required."}],"role":"symbol","title":"isVerificationRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"debugDescription","type":"topic","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","url":"\/documentation\/auth0\/authenticationerror\/debugdescription","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"kind":"symbol","title":"info","type":"topic","abstract":[{"type":"text","text":"Additional information about the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","url":"\/documentation\/auth0\/authenticationerror\/info","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isPasswordAlreadyUsed","type":"topic","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 "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true},{"type":"text","text":" dictionary."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"kind":"article","title":"Auth0Error Implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)"],"title":"Initializers"},{"title":"Instance Properties","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"]},{"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"}],"metadata":{"role":"symbol","symbolKind":"struct","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"externalID":"s:5Auth019AuthenticationErrorV","modules":[{"name":"Auth0"}],"title":"AuthenticationError","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}]},"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"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","title":"isRuleError","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":"."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isRuleError","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","title":"isMultifactorRequired","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","title":"isMultifactorTokenInvalid","abstract":[{"text":"When the MFA token is invalid or expired.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/debugdescription","title":"debugDescription","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","title":"isPasswordLeaked","abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","abstract":[{"type":"text","text":"When MFA is required and the user is not enrolled."}],"type":"topic","title":"isMultifactorEnrollRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","title":"isRefreshTokenDeleted","abstract":[{"type":"text","text":"When the credentials renewal fails because the user was deleted."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","title":"isTooManyAttempts","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isTooManyAttempts","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","title":"isVerificationRequired","abstract":[{"text":"When an additional verification step is required.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","title":"isPasswordAlreadyUsed","abstract":[{"type":"text","text":"When the password used for signup was already used before. This is reported when the Password History feature"},{"text":" ","type":"text"},{"type":"text","text":"is enabled."},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference"},{"type":"text","text":" dictionary."}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"type":"topic","title":"Auth0Error Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"url":"\/documentation\/auth0\/authenticationerror\/statuscode","title":"statusCode","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"abstract":[{"type":"text","text":"The code of the error as a string."}],"type":"topic","title":"code","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/authenticationerror\/code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"abstract":[{"text":"Additional information about the error.","type":"text"}],"type":"topic","title":"info","url":"\/documentation\/auth0\/authenticationerror\/info","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","kind":"symbol","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":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","title":"Equatable Implementations","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","type":"topic","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","title":"isNetworkError","abstract":[{"text":"When the request failed due to network issues.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isNetworkError","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","title":"isMultifactorCodeInvalid","abstract":[{"type":"text","text":"When the MFA code sent is invalid or expired."}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","title":"isInvalidCredentials","abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isInvalidCredentials","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"type":"topic","abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"type":"text","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."}],"title":"isPasswordNotStrongEnough","url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/cause","title":"cause","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"title":"isLoginRequired","type":"topic","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":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isloginrequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"type":"topic","abstract":[],"kind":"symbol","title":"isInvalidRefreshToken","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","title":"init(info:statusCode:)","url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"role":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"kind":"symbol"},"https://auth0.com/docs/api/authentication#standard-error-responses":{"titleInlineContent":[{"type":"text","text":"Standard Error Responses"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","type":"link","title":"Standard Error Responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","title":"isAccessDenied","abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isAccessDenied"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json b/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json index ba86bcfd..3050ba0d 100644 --- a/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json +++ b/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"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"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"]}]}],"metadata":{"extendedModule":"Swift","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth019AuthenticationErrorV","role":"symbol","roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"symbolKind":"op","title":"!=(_:_:)","modules":[{"relatedModules":["Swift"],"name":"Auth0"}]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","interfaceLanguage":"swift"},"sections":[],"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/AuthenticationError/!=(_:_:)":{"role":"symbol","kind":"symbol","abstract":[],"title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"kind":"article","title":"Equatable Implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)"},"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"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/!=(_:_:)"]}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"symbolKind":"op","roleHeading":"Operator","title":"!=(_:_:)","extendedModule":"Swift","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth019AuthenticationErrorV"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"text":".","type":"text"}],"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","title":"Equatable Implementations","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","type":"topic","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","role":"symbol","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"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","title":"!=(_:_:)","abstract":[],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/==(_:_:).json b/docs/data/documentation/auth0/authenticationerror/==(_:_:).json index abcbc6d6..e29b2ba1 100644 --- a/docs/data/documentation/auth0/authenticationerror/==(_:_:).json +++ b/docs/data/documentation/auth0/authenticationerror/==(_:_:).json @@ -1 +1 @@ -{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/==(_:_:)"]}],"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":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)"},"metadata":{"symbolKind":"op","title":"==(_:_:)","roleHeading":"Operator","role":"symbol","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","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:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth019AuthenticationErrorV2eeoiySbAC_ACtFZ"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"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\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"kind":"article","title":"Equatable Implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","metadata":{"symbolKind":"op","roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"extendedModule":"Auth0","title":"==(_:_:)","externalID":"s:5Auth019AuthenticationErrorV2eeoiySbAC_ACtFZ","role":"symbol","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","interfaceLanguage":"swift"},"abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/==(_:_:)"]}],"sections":[],"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":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","type":"topic","role":"symbol","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":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","title":"==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","title":"Equatable Implementations","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","type":"topic","kind":"article"}}} \ 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 83be7331..c2a7f9e7 100644 --- a/docs/data/documentation/auth0/authenticationerror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/auth0error-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/auth0error-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"metadata":{"role":"collectionGroup","roleHeading":"API Collection","title":"Auth0Error Implementations","modules":[{"name":"Auth0"}]},"sections":[],"topicSections":[{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","title":"errorDescription","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/errordescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","role":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"role":"collectionGroup","roleHeading":"API Collection","title":"Auth0Error Implementations","modules":[{"name":"Auth0"}]},"sections":[],"topicSections":[{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/authenticationerror\/errordescription","title":"errorDescription","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"role":"symbol","title":"localizedDescription","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 6a046399..ef662ad1 100644 --- a/docs/data/documentation/auth0/authenticationerror/cause.json +++ b/docs/data/documentation/auth0/authenticationerror/cause.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/cause"]}],"kind":"symbol","sections":[],"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":"."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV5causes0C0_pSgvp","role":"symbol","symbolKind":"property","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"title":"cause"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","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":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"kind":"symbol","title":"cause","type":"topic","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","url":"\/documentation\/auth0\/authenticationerror\/cause","role":"symbol"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"metadata":{"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","symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV5causes0C0_pSgvp"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause"},"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"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/cause","title":"cause","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 89b18568..8ecbdd4e 100644 --- a/docs/data/documentation/auth0/authenticationerror/code.json +++ b/docs/data/documentation/auth0/authenticationerror/code.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","abstract":[{"type":"text","text":"The code of the error as a string."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/code"]}],"metadata":{"symbolKind":"property","title":"code","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV4codeSSvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/code","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","title":"code","abstract":[{"type":"text","text":"The code of the error as a string."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"text":"The code of the error as a string.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/code"]}],"sections":[],"metadata":{"roleHeading":"Instance Property","title":"code","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV4codeSSvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"abstract":[{"type":"text","text":"The code of the error as a string."}],"type":"topic","title":"code","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/authenticationerror\/code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 2c2aa285..b4ea048c 100644 --- a/docs/data/documentation/auth0/authenticationerror/debugdescription.json +++ b/docs/data/documentation/auth0/authenticationerror/debugdescription.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","metadata":{"title":"debugDescription","roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV16debugDescriptionSSvp","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"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"}]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"type":"text","text":" only."}]}],"type":"aside","name":"Important"}]}],"abstract":[{"type":"text","text":"Description of the error."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/debugdescription"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"debugDescription","type":"topic","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","url":"\/documentation\/auth0\/authenticationerror\/debugdescription","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"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"},{"type":"text","text":" only."}],"type":"paragraph"}],"name":"Important","type":"aside","style":"important"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"symbolKind":"property","roleHeading":"Instance Property","title":"debugDescription","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth019AuthenticationErrorV16debugDescriptionSSvp"},"kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/debugdescription"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/debugdescription","title":"debugDescription","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 2b77e649..7771016e 100644 --- a/docs/data/documentation/auth0/authenticationerror/equatable-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/equatable-implementations.json @@ -1 +1 @@ -{"sections":[],"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations"},"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","modules":[{"name":"Auth0"}],"title":"Equatable Implementations","roleHeading":"API Collection"},"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)"]}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"role":"symbol","kind":"symbol","abstract":[],"title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","roleHeading":"API Collection","title":"Equatable Implementations"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)"],"title":"Operators","generated":true}],"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","role":"symbol","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"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","title":"!=(_:_:)","abstract":[],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","type":"topic","role":"symbol","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":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","title":"==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 3997ddc0..3d531f3f 100644 --- a/docs/data/documentation/auth0/authenticationerror/errordescription.json +++ b/docs/data/documentation/auth0/authenticationerror/errordescription.json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"type":"heading","text":"Discussion","anchor":"discussion"},{"style":"important","type":"aside","name":"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"}]},{"type":"text","text":" only."}],"type":"paragraph"}]}]}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/errordescription"],"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"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Description of the error."}],"metadata":{"roleHeading":"Instance Property","extendedModule":"Auth0","role":"symbol","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"errorDescription"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"kind":"article","title":"Auth0Error Implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","title":"errorDescription","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/errordescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"errorDescription","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","roleHeading":"Instance Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"type":"aside","name":"Important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"type":"text","text":" only."}]}],"style":"important"}]}],"abstract":[{"text":"Description of the error.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","interfaceLanguage":"swift"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/errordescription"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/authenticationerror\/errordescription","title":"errorDescription","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"type":"topic","title":"Auth0Error Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 4eedb5c4..bc5ca7d5 100644 --- a/docs/data/documentation/auth0/authenticationerror/failurereason.json +++ b/docs/data/documentation/auth0/authenticationerror/failurereason.json @@ -1 +1 @@ -{"kind":"symbol","metadata":{"role":"symbol","roleHeading":"Instance Property","title":"failureReason","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"symbolKind":"property","extendedModule":"Foundation","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"platforms":[{"introducedAt":"8.0","beta":false,"name":"iOS","deprecated":false,"unavailable":false},{"introducedAt":"10.10","name":"macOS","deprecated":false,"unavailable":false,"beta":false},{"unavailable":false,"name":"tvOS","beta":false,"introducedAt":"9.0","deprecated":false},{"name":"watchOS","beta":false,"introducedAt":"2.0","deprecated":false,"unavailable":false}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/failurereason"]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","title":"LocalizedError Implementations","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"role":"symbol","abstract":[],"type":"topic","title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","interfaceLanguage":"swift"},"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":[],"metadata":{"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","title":"failureReason","extendedModule":"Foundation","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"role":"symbol","platforms":[{"deprecated":false,"beta":false,"introducedAt":"8.0","name":"iOS","unavailable":false},{"name":"macOS","introducedAt":"10.10","unavailable":false,"beta":false,"deprecated":false},{"beta":false,"introducedAt":"9.0","deprecated":false,"name":"tvOS","unavailable":false},{"name":"watchOS","unavailable":false,"deprecated":false,"beta":false,"introducedAt":"2.0"}]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/failurereason"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","url":"\/documentation\/auth0\/authenticationerror","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"title":"AuthenticationError","abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"type":"topic","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"failureReason","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/failurereason","kind":"symbol","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason"}}} \ 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 ffb47336..17f533d1 100644 --- a/docs/data/documentation/auth0/authenticationerror/helpanchor.json +++ b/docs/data/documentation/auth0/authenticationerror/helpanchor.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"text":".","type":"text"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]]},"metadata":{"role":"symbol","platforms":[{"deprecated":false,"introducedAt":"8.0","beta":false,"name":"iOS","unavailable":false},{"deprecated":false,"introducedAt":"10.10","name":"macOS","beta":false,"unavailable":false},{"beta":false,"introducedAt":"9.0","unavailable":false,"name":"tvOS","deprecated":false},{"unavailable":false,"beta":false,"deprecated":false,"introducedAt":"2.0","name":"watchOS"}],"extendedModule":"Foundation","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","roleHeading":"Instance Property","title":"helpAnchor","symbolKind":"property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/helpanchor"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","title":"helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/helpanchor","type":"topic","abstract":[],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","title":"LocalizedError Implementations","abstract":[],"role":"collectionGroup"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/helpanchor"]}],"metadata":{"extendedModule":"Foundation","platforms":[{"deprecated":false,"name":"iOS","beta":false,"introducedAt":"8.0","unavailable":false},{"introducedAt":"10.10","name":"macOS","beta":false,"unavailable":false,"deprecated":false},{"name":"tvOS","introducedAt":"9.0","unavailable":false,"beta":false,"deprecated":false},{"introducedAt":"2.0","name":"watchOS","unavailable":false,"deprecated":false,"beta":false}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","title":"helpAnchor","symbolKind":"property","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"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":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"title":"helpAnchor","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/helpanchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","role":"symbol","kind":"symbol","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 6400c612..fdf8ca2c 100644 --- a/docs/data/documentation/auth0/authenticationerror/info.json +++ b/docs/data/documentation/auth0/authenticationerror/info.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},"abstract":[{"type":"text","text":"Additional information about the error."}],"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","title":"info","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV4infoSDySSypGvp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/info"],"traits":[{"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":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"kind":"symbol","title":"info","type":"topic","abstract":[{"type":"text","text":"Additional information about the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","url":"\/documentation\/auth0\/authenticationerror\/info","role":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Additional information about the error."}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV4infoSDySSypGvp","title":"info"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/info"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","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"}],"type":"topic","title":"info","url":"\/documentation\/auth0\/authenticationerror\/info","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","kind":"symbol","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":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 385e8f0a..17d286bd 100644 --- a/docs/data/documentation/auth0/authenticationerror/init(info:statuscode:).json +++ b/docs/data/documentation/auth0/authenticationerror/init(info:statuscode:).json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Initializer","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV4info10statusCodeACSDySSypG_Sitcfc","title":"init(info:statusCode:)","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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"}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"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":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"info","content":[{"type":"paragraph","inlineContent":[{"text":"JSON response from Auth0.","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"HTTP status code of the response.","type":"text"}],"type":"paragraph"}],"name":"statusCode"}]},{"kind":"content","content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"AuthenticationError"},{"text":".","type":"text"}]}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"kind":"symbol","title":"init(info:statusCode:)","type":"topic","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","role":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":")","kind":"text"}]}]},{"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"}]}]},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"AuthenticationError"},{"type":"text","text":"."}]}],"kind":"content"}],"metadata":{"title":"init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","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":")"}],"role":"symbol","symbolKind":"init","externalID":"s:5Auth019AuthenticationErrorV4info10statusCodeACSDySSypG_Sitcfc","roleHeading":"Initializer","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","title":"init(info:statusCode:)","url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"role":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 7a7994cc..b6fbc119 100644 --- a/docs/data/documentation/auth0/authenticationerror/isaccessdenied.json +++ b/docs/data/documentation/auth0/authenticationerror/isaccessdenied.json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"symbolKind":"property","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isAccessDenied","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth019AuthenticationErrorV14isAccessDeniedSbvp","title":"isAccessDenied","role":"symbol","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isaccessdenied"]}],"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 Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isAccessDenied","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isAccessDenied","type":"topic","abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isAccessDenied","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","interfaceLanguage":"swift"},"sections":[],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"isAccessDenied","externalID":"s:5Auth019AuthenticationErrorV14isAccessDeniedSbvp","roleHeading":"Instance Property"},"abstract":[{"text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isaccessdenied"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","title":"isAccessDenied","abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isAccessDenied"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 9abe39b7..dedaf49c 100644 --- a/docs/data/documentation/auth0/authenticationerror/isinvalidcredentials.json +++ b/docs/data/documentation/auth0/authenticationerror/isinvalidcredentials.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV20isInvalidCredentialsSbvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidCredentials","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"isInvalidCredentials","symbolKind":"property","role":"symbol","roleHeading":"Instance Property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isInvalidCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"When the username and\/or password used for authentication are invalid."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","title":"isInvalidCredentials","type":"topic","abstract":[{"type":"text","text":"When the username and\/or password used for authentication are invalid."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV20isInvalidCredentialsSbvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidCredentials"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","symbolKind":"property","roleHeading":"Instance Property","title":"isInvalidCredentials"},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials"},"abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isInvalidCredentials","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"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","title":"isInvalidCredentials","abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isInvalidCredentials","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 017a8253..20c694d1 100644 --- a/docs/data/documentation/auth0/authenticationerror/isinvalidrefreshtoken.json +++ b/docs/data/documentation/auth0/authenticationerror/isinvalidrefreshtoken.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV21isInvalidRefreshTokenSbvp","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidRefreshToken"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"isInvalidRefreshToken"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isInvalidRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isInvalidRefreshToken","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"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"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken"},"metadata":{"externalID":"s:5Auth019AuthenticationErrorV21isInvalidRefreshTokenSbvp","symbolKind":"property","title":"isInvalidRefreshToken","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isInvalidRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"type":"topic","abstract":[],"kind":"symbol","title":"isInvalidRefreshToken","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 6adc92b7..864bbd78 100644 --- a/docs/data/documentation/auth0/authenticationerror/isloginrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/isloginrequired.json @@ -1 +1 @@ -{"abstract":[{"text":"When performing Web Auth login with ","type":"text"},{"code":"prompt: \"none\"","type":"codeVoice"},{"text":" and the Auth0 session has expired.","type":"text"}],"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV15isLoginRequiredSbvp","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isLoginRequired"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","title":"isLoginRequired","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isLoginRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isloginrequired"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired"},"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isLoginRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isLoginRequired","type":"topic","abstract":[{"type":"text","text":"When performing Web Auth login with "},{"type":"codeVoice","code":"prompt: \"none\""},{"type":"text","text":" and the Auth0 session has expired."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","url":"\/documentation\/auth0\/authenticationerror\/isloginrequired","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isloginrequired"]}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"isLoginRequired","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV15isLoginRequiredSbvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isLoginRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"When performing Web Auth login with "},{"type":"codeVoice","code":"prompt: \"none\""},{"text":" and the Auth0 session has expired.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","url":"\/documentation\/auth0\/authenticationerror","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"title":"AuthenticationError","abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"type":"topic","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"title":"isLoginRequired","type":"topic","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":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isloginrequired"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 1c57408d..3f74175c 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactorcodeinvalid.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactorcodeinvalid.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"role":"symbol","title":"isMultifactorCodeInvalid","externalID":"s:5Auth019AuthenticationErrorV24isMultifactorCodeInvalidSbvp","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"When the MFA code sent is invalid or expired."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","title":"isMultifactorCodeInvalid","type":"topic","abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","role":"symbol"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid"},"sections":[],"metadata":{"role":"symbol","symbolKind":"property","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorCodeInvalid","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV24isMultifactorCodeInvalidSbvp"},"abstract":[{"type":"text","text":"When the MFA code sent is invalid or expired."}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","title":"isMultifactorCodeInvalid","abstract":[{"type":"text","text":"When the MFA code sent is invalid or expired."}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 05606335..f771c3d0 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactorenrollrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactorenrollrequired.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired"]}],"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":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV27isMultifactorEnrollRequiredSbvp","title":"isMultifactorEnrollRequired","symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isMultifactorEnrollRequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required and the user is not enrolled."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ 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\/ismultifactorenrollrequired"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired"},"metadata":{"externalID":"s:5Auth019AuthenticationErrorV27isMultifactorEnrollRequiredSbvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","title":"isMultifactorEnrollRequired","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol"},"kind":"symbol","abstract":[{"type":"text","text":"When MFA is required and the user is not enrolled."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","abstract":[{"type":"text","text":"When MFA is required and the user is not enrolled."}],"type":"topic","title":"isMultifactorEnrollRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 52c934da..c257d8d5 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactorrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactorrequired.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorrequired"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV21isMultifactorRequiredSbvp","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"isMultifactorRequired","symbolKind":"property","role":"symbol","roleHeading":"Instance Property"},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"kind":"symbol","title":"isMultifactorRequired"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorrequired"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"isMultifactorRequired","externalID":"s:5Auth019AuthenticationErrorV21isMultifactorRequiredSbvp","roleHeading":"Instance Property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","title":"isMultifactorRequired","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}]}}} \ 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 0ba68bbd..0e255413 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactortokeninvalid.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactortokeninvalid.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"text":"When the MFA token is invalid or expired.","type":"text"}],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"symbolKind":"property","title":"isMultifactorTokenInvalid","roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV25isMultifactorTokenInvalidSbvp","modules":[{"name":"Auth0"}],"role":"symbol"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isMultifactorTokenInvalid","type":"topic","abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"externalID":"s:5Auth019AuthenticationErrorV25isMultifactorTokenInvalidSbvp","roleHeading":"Instance Property","title":"isMultifactorTokenInvalid","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"sections":[],"abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"text":": ","kind":"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":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","title":"isMultifactorTokenInvalid","abstract":[{"text":"When the MFA token is invalid or expired.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/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 f9de3329..365f4d6a 100644 --- a/docs/data/documentation/auth0/authenticationerror/isnetworkerror.json +++ b/docs/data/documentation/auth0/authenticationerror/isnetworkerror.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isnetworkerror"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"inlineContent":[{"type":"text","text":"Returns "},{"code":"true","type":"codeVoice"},{"type":"text","text":" when the "},{"type":"codeVoice","code":"URLError"},{"type":"text","text":" code is one of the following:"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","type":"reference"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost","isActive":true,"type":"reference"}]}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","isActive":true}]}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","type":"reference","isActive":true}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive","isActive":true}]}]}],"type":"unorderedList"},{"type":"paragraph","inlineContent":[{"text":"The underlying ","type":"text"},{"code":"URLError","type":"codeVoice"},{"type":"text","text":" is available in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":" property.","type":"text"}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"isNetworkError","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV09isNetworkC0Sbvp","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","roleHeading":"Instance Property"},"abstract":[{"type":"text","text":"When the request failed due to network issues."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://developer.apple.com/documentation/foundation/urlerror/2293460-cannotfindhost":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost","type":"link","titleInlineContent":[{"text":"cannotFindHost","type":"text"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost","title":"cannotFindHost"},"https://developer.apple.com/documentation/foundation/urlerror/2293028-cannotconnecttohost":{"titleInlineContent":[{"type":"text","text":"cannotConnectToHost"}],"title":"cannotConnectToHost","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost"},"https://developer.apple.com/documentation/foundation/urlerror/2293104-notconnectedtointernet":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","type":"link","titleInlineContent":[{"text":"notConnectedToInternet","type":"text"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","title":"notConnectedToInternet"},"https://developer.apple.com/documentation/foundation/urlerror/2293759-networkconnectionlost":{"titleInlineContent":[{"type":"text","text":"networkConnectionLost"}],"title":"networkConnectionLost","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost"},"https://developer.apple.com/documentation/foundation/urlerror/2292893-internationalroamingoff":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","type":"link","titleInlineContent":[{"text":"internationalRoamingOff","type":"text"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","title":"internationalRoamingOff"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","title":"isNetworkError","type":"topic","abstract":[{"type":"text","text":"When the request failed due to network issues."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","role":"symbol"},"https://developer.apple.com/documentation/foundation/urlerror/2293147-callisactive":{"titleInlineContent":[{"type":"text","text":"callIsActive"}],"title":"callIsActive","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"https://developer.apple.com/documentation/foundation/urlerror/2293002-timedout":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","type":"link","titleInlineContent":[{"text":"timedOut","type":"text"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","title":"timedOut"},"https://developer.apple.com/documentation/foundation/urlerror/2293434-dnslookupfailed":{"titleInlineContent":[{"text":"dnsLookupFailed","type":"text"}],"type":"link","title":"dnsLookupFailed","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"Returns ","type":"text"},{"code":"true","type":"codeVoice"},{"type":"text","text":" when the "},{"type":"codeVoice","code":"URLError"},{"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":[{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost","type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed","isActive":true}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","type":"reference","isActive":true}]}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive","type":"reference","isActive":true}],"type":"paragraph"}]}]},{"inlineContent":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"URLError"},{"text":" is available in the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":" property.","type":"text"}],"type":"paragraph"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isnetworkerror"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV09isNetworkC0Sbvp","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isNetworkError","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"symbolKind":"property","title":"isNetworkError","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"When the request failed due to network issues."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"https://developer.apple.com/documentation/foundation/urlerror/2293460-cannotfindhost":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost","type":"link","title":"cannotFindHost","titleInlineContent":[{"type":"text","text":"cannotFindHost"}]},"https://developer.apple.com/documentation/foundation/urlerror/2293147-callisactive":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive","titleInlineContent":[{"type":"text","text":"callIsActive"}],"title":"callIsActive","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/2293028-cannotconnecttohost":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost","type":"link","title":"cannotConnectToHost","titleInlineContent":[{"type":"text","text":"cannotConnectToHost"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://developer.apple.com/documentation/foundation/urlerror/2293104-notconnectedtointernet":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","titleInlineContent":[{"type":"text","text":"notConnectedToInternet"}],"title":"notConnectedToInternet","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","type":"link"},"https://developer.apple.com/documentation/foundation/urlerror/2293759-networkconnectionlost":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost","type":"link","title":"networkConnectionLost","titleInlineContent":[{"type":"text","text":"networkConnectionLost"}]},"https://developer.apple.com/documentation/foundation/urlerror/2292893-internationalroamingoff":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","titleInlineContent":[{"type":"text","text":"internationalRoamingOff"}],"title":"internationalRoamingOff","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","title":"isNetworkError","abstract":[{"text":"When the request failed due to network issues.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isNetworkError","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError"},"https://developer.apple.com/documentation/foundation/urlerror/2293002-timedout":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","type":"link","title":"timedOut","titleInlineContent":[{"type":"text","text":"timedOut"}]},"https://developer.apple.com/documentation/foundation/urlerror/2293434-dnslookupfailed":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed","titleInlineContent":[{"type":"text","text":"dnsLookupFailed"}],"title":"dnsLookupFailed","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed","type":"link"}}} \ 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 18adbe29..6e25805e 100644 --- a/docs/data/documentation/auth0/authenticationerror/ispasswordalreadyused.json +++ b/docs/data/documentation/auth0/authenticationerror/ispasswordalreadyused.json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"schemaVersion":{"major":0,"minor":3,"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."},{"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."}],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV21isPasswordAlreadyUsedSbvp","role":"symbol","modules":[{"name":"Auth0"}],"title":"isPasswordAlreadyUsed","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isPasswordAlreadyUsed","type":"topic","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 "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true},{"type":"text","text":" dictionary."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"kind":"symbol","title":"info","type":"topic","abstract":[{"type":"text","text":"Additional information about the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","url":"\/documentation\/auth0\/authenticationerror\/info","role":"symbol"}}} \ No newline at end of file +{"sections":[],"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"},{"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},{"text":" dictionary.","type":"text"}],"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":"isPasswordAlreadyUsed","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV21isPasswordAlreadyUsedSbvp","symbolKind":"property","title":"isPasswordAlreadyUsed","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"abstract":[{"text":"Additional information about the error.","type":"text"}],"type":"topic","title":"info","url":"\/documentation\/auth0\/authenticationerror\/info","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","kind":"symbol","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":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","title":"isPasswordAlreadyUsed","abstract":[{"type":"text","text":"When the password used for signup was already used before. This is reported when the Password History feature"},{"text":" ","type":"text"},{"type":"text","text":"is enabled."},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference"},{"type":"text","text":" dictionary."}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 e5e1995d..dc6d63e3 100644 --- a/docs/data/documentation/auth0/authenticationerror/ispasswordleaked.json +++ b/docs/data/documentation/auth0/authenticationerror/ispasswordleaked.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordLeaked","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"isPasswordLeaked","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV16isPasswordLeakedSbvp"},"abstract":[{"type":"text","text":"When the password used was reported to be leaked."}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordLeaked"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordleaked"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordLeaked","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isPasswordLeaked","type":"topic","abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordLeaked"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"role":"symbol","roleHeading":"Instance Property","title":"isPasswordLeaked","externalID":"s:5Auth019AuthenticationErrorV16isPasswordLeakedSbvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isPasswordLeaked","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0"}],"symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"When the password used was reported to be leaked."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordleaked"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","title":"isPasswordLeaked","abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 cb9b0f80..514bc18d 100644 --- a/docs/data/documentation/auth0/authenticationerror/ispasswordnotstrongenough.json +++ b/docs/data/documentation/auth0/authenticationerror/ispasswordnotstrongenough.json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"metadata":{"symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"isPasswordNotStrongEnough","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV25isPasswordNotStrongEnoughSbvp"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"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"},{"text":" dictionary.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"isPasswordNotStrongEnough","type":"topic","abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"type":"text","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."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"kind":"symbol","title":"info","type":"topic","abstract":[{"type":"text","text":"Additional information about the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","url":"\/documentation\/auth0\/authenticationerror\/info","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"metadata":{"title":"isPasswordNotStrongEnough","externalID":"s:5Auth019AuthenticationErrorV25isPasswordNotStrongEnoughSbvp","modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"type":"text","text":" "},{"text":"Additional information is available in the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true,"type":"reference"},{"text":" dictionary.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough"},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"abstract":[{"text":"Additional information about the error.","type":"text"}],"type":"topic","title":"info","url":"\/documentation\/auth0\/authenticationerror\/info","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","kind":"symbol","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":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"type":"topic","abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"type":"text","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."}],"title":"isPasswordNotStrongEnough","url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 229ce7f4..ea4efa3b 100644 --- a/docs/data/documentation/auth0/authenticationerror/isrefreshtokendeleted.json +++ b/docs/data/documentation/auth0/authenticationerror/isrefreshtokendeleted.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"symbolKind":"property","title":"isRefreshTokenDeleted","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV21isRefreshTokenDeletedSbvp","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"When the credentials renewal fails because the user was deleted.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isRefreshTokenDeleted"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","title":"isRefreshTokenDeleted","type":"topic","abstract":[{"type":"text","text":"When the credentials renewal fails because the user was deleted."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"When the credentials renewal fails because the user was deleted."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth019AuthenticationErrorV21isRefreshTokenDeletedSbvp","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","title":"isRefreshTokenDeleted","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","title":"isRefreshTokenDeleted","abstract":[{"type":"text","text":"When the credentials renewal fails because the user was deleted."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 8b2ed799..8febbd0b 100644 --- a/docs/data/documentation/auth0/authenticationerror/isruleerror.json +++ b/docs/data/documentation/auth0/authenticationerror/isruleerror.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"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","metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isRuleError"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"isRuleError","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV06isRuleC0Sbvp"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isruleerror"]}],"sections":[],"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 "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","isActive":true},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","title":"isRuleError","type":"topic","abstract":[{"text":"When an Auth0 rule returns an error.","type":"text"},{"text":" ","type":"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":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/auth0error\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth019AuthenticationErrorV06isRuleC0Sbvp","title":"isRuleError","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isRuleError","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isruleerror"]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"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 "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isRuleError"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","title":"isRuleError","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":"."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isRuleError","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 f6486a24..5799d292 100644 --- a/docs/data/documentation/auth0/authenticationerror/istoomanyattempts.json +++ b/docs/data/documentation/auth0/authenticationerror/istoomanyattempts.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth019AuthenticationErrorV17isTooManyAttemptsSbvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isTooManyAttempts","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isTooManyAttempts","roleHeading":"Instance Property","symbolKind":"property","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isTooManyAttempts"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/istoomanyattempts"]}],"abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","title":"isTooManyAttempts","type":"topic","abstract":[{"text":"When the user is blocked due to too many attempts to log in.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","role":"symbol"}}} \ No newline at end of file +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/istoomanyattempts"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV17isTooManyAttemptsSbvp","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isTooManyAttempts"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"isTooManyAttempts","role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","title":"isTooManyAttempts","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isTooManyAttempts","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 cf0ad20f..159569bc 100644 --- a/docs/data/documentation/auth0/authenticationerror/isverificationrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/isverificationrequired.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"type":"text","text":"When an additional verification step is required."}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isverificationrequired"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired"},"metadata":{"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","title":"isVerificationRequired","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV22isVerificationRequiredSbvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isVerificationRequired","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","type":"topic","abstract":[{"type":"text","text":"When an additional verification step is required."}],"role":"symbol","title":"isVerificationRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isverificationrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isVerificationRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"sections":[],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV22isVerificationRequiredSbvp","symbolKind":"property","title":"isVerificationRequired","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isVerificationRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"abstract":[{"type":"text","text":"When an additional verification step is required."}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","title":"isVerificationRequired","abstract":[{"text":"When an additional verification step is required.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired"}}} \ 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 bd8650aa..0a479acb 100644 --- a/docs/data/documentation/auth0/authenticationerror/localizeddescription.json +++ b/docs/data/documentation/auth0/authenticationerror/localizeddescription.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\/Auth0Error-Implementations"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription"},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"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"}],"style":"important","type":"aside","name":"Important"}]}],"kind":"symbol","metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"localizedDescription","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","role":"symbol","symbolKind":"property","extendedModule":"Auth0"},"abstract":[{"text":"Description of the error.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"kind":"article","title":"Auth0Error Implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","role":"symbol"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","interfaceLanguage":"swift"},"abstract":[{"text":"Description of the error.","type":"text"}],"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","extendedModule":"Auth0","title":"localizedDescription","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"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":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}],"type":"paragraph"}],"name":"Important"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"role":"symbol","title":"localizedDescription","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"type":"topic","title":"Auth0Error Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","role":"collectionGroup"}}} \ 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 25751d99..8d5997ef 100644 --- a/docs/data/documentation/auth0/authenticationerror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/localizederror-implementations.json @@ -1 +1 @@ -{"sections":[],"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/localizederror-implementations"]}],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"roleHeading":"API Collection","role":"collectionGroup","title":"LocalizedError Implementations","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"role":"symbol","abstract":[],"type":"topic","title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","title":"recoverySuggestion","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","title":"helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/helpanchor","type":"topic","abstract":[],"kind":"symbol","role":"symbol"}}} \ No newline at end of file +{"sections":[],"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"LocalizedError Implementations","role":"collectionGroup"},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/localizederror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"generated":true,"title":"Instance Properties","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"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"failureReason","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/failurereason","kind":"symbol","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","title":"recoverySuggestion","url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"title":"helpAnchor","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/helpanchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","role":"symbol","kind":"symbol","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]}}} \ 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 46dd75f5..d3af874b 100644 --- a/docs/data/documentation/auth0/authenticationerror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/authenticationerror/recoverysuggestion.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"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":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion"},"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","roleHeading":"Instance Property","platforms":[{"deprecated":false,"unavailable":false,"beta":false,"name":"iOS","introducedAt":"8.0"},{"introducedAt":"10.10","deprecated":false,"unavailable":false,"name":"macOS","beta":false},{"deprecated":false,"unavailable":false,"introducedAt":"9.0","beta":false,"name":"tvOS"},{"deprecated":false,"name":"watchOS","unavailable":false,"introducedAt":"2.0","beta":false}],"role":"symbol","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"title":"recoverySuggestion","extendedModule":"Foundation"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/recoverysuggestion"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","title":"recoverySuggestion","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","title":"LocalizedError Implementations","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]]},"kind":"symbol","metadata":{"role":"symbol","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"symbolKind":"property","platforms":[{"name":"iOS","unavailable":false,"beta":false,"deprecated":false,"introducedAt":"8.0"},{"name":"macOS","unavailable":false,"introducedAt":"10.10","beta":false,"deprecated":false},{"name":"tvOS","beta":false,"unavailable":false,"introducedAt":"9.0","deprecated":false},{"beta":false,"introducedAt":"2.0","unavailable":false,"deprecated":false,"name":"watchOS"}],"title":"recoverySuggestion","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"extendedModule":"Foundation","roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV"},"schemaVersion":{"minor":3,"patch":0,"major":0},"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/recoverySuggestion":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","title":"recoverySuggestion","url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 b3508528..1b55d038 100644 --- a/docs/data/documentation/auth0/authenticationerror/statuscode.json +++ b/docs/data/documentation/auth0/authenticationerror/statuscode.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/statuscode"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"title":"statusCode","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV10statusCodeSivp","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"kind":"symbol","title":"statusCode","type":"topic","abstract":[{"type":"text","text":"HTTP status code of the response."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","url":"\/documentation\/auth0\/authenticationerror\/statuscode","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"platforms":["iOS"]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"externalID":"s:5Auth019AuthenticationErrorV10statusCodeSivp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"title":"statusCode","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/statuscode"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"url":"\/documentation\/auth0\/authenticationerror\/statuscode","title":"statusCode","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 2c2bc31e..27ef12a3 100644 --- a/docs/data/documentation/auth0/authenticationresult.json +++ b/docs/data/documentation/auth0/authenticationresult.json @@ -1 +1 @@ -{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationresult"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Authentication API operations.","type":"text"}],"metadata":{"roleHeading":"Type Alias","externalID":"s:5Auth020AuthenticationResulta","symbolKind":"typealias","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"role":"symbol","title":"AuthenticationResult","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationResult"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"kind":"typeIdentifier","text":"Result","preciseIdentifier":"s:s6ResultO"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationResulta1Txmfp"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AuthenticationResult"}],"type":"topic","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Authentication API operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","role":"symbol","title":"AuthenticationResult","url":"\/documentation\/auth0\/authenticationresult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Authentication API operations.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"symbolKind":"typealias","externalID":"s:5Auth020AuthenticationResulta","title":"AuthenticationResult","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"roleHeading":"Type Alias","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"AuthenticationResult","kind":"identifier"}],"role":"symbol"},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationResult"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"text":"> = ","kind":"text"},{"text":"Result","kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth020AuthenticationResulta1Txmfp"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationresult"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Authentication API operations."}],"type":"topic","title":"AuthenticationResult","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationResult"}],"kind":"symbol","navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"url":"\/documentation\/auth0\/authenticationresult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 b81e55a8..356dcf2b 100644 --- a/docs/data/documentation/auth0/challenge.json +++ b/docs/data/documentation/auth0/challenge.json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"role":"symbol","title":"Challenge","roleHeading":"Structure","externalID":"s:5Auth09ChallengeV"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","interfaceLanguage":"swift"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"],"title":"Initializers"},{"title":"Instance Properties","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"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge"]}],"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"kind":"relationships"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","title":"bindingMethod","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/challenge\/bindingmethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"When the challenge response includes a "},{"type":"codeVoice","code":"prompt"},{"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."}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"title":"challengeType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","kind":"symbol","url":"\/documentation\/auth0\/challenge\/challengetype","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}]},"doc://com.auth0.Auth0/SE":{"identifier":"doc:\/\/com.auth0.Auth0\/SE","type":"unresolvable","title":"Swift.Encodable"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"url":"\/documentation\/auth0\/challenge\/init(from:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","title":"init(from:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","abstract":[{"type":"text","text":"Out-of-Band (OOB) code."}],"title":"oobCode","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"oobCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/challenge\/oobcode"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable","title":"Swift.Decodable"}}} \ No newline at end of file +{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"title":"Challenge","externalID":"s:5Auth09ChallengeV","roleHeading":"Structure"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"]},{"title":"Instance Properties","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"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"A multi-factor challenge."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge"]}],"kind":"symbol","relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"type":"conformsTo"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"url":"\/documentation\/auth0\/challenge","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/challenge\/challengetype","title":"challengeType","role":"symbol","abstract":[{"text":"How the user will get the challenge and prove possession.","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://com.auth0.Auth0/SE":{"identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"role":"symbol","type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"url":"\/documentation\/auth0\/challenge\/init(from:)","abstract":[],"title":"init(from:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"abstract":[{"text":"When the challenge response includes a ","type":"text"},{"code":"prompt","type":"codeVoice"},{"type":"text","text":" binding method, your app needs to prompt the user for the"},{"text":" ","type":"text"},{"code":"binding_code","type":"codeVoice"},{"text":" and send it as part of the request.","type":"text"}],"type":"topic","title":"bindingMethod","url":"\/documentation\/auth0\/challenge\/bindingmethod","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"role":"symbol","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"oobCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/challenge\/oobcode","abstract":[{"text":"Out-of-Band (OOB) code.","type":"text"}],"title":"oobCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","kind":"symbol"}}} \ 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 bafc0100..76bbcf07 100644 --- a/docs/data/documentation/auth0/challenge/bindingmethod.json +++ b/docs/data/documentation/auth0/challenge/bindingmethod.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"variants":[{"paths":["\/documentation\/auth0\/challenge\/bindingmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"bindingMethod","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth09ChallengeV13bindingMethodSSSgvp","title":"bindingMethod","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","symbolKind":"property","roleHeading":"Instance Property"},"sections":[],"abstract":[{"text":"When the challenge response includes a ","type":"text"},{"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"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","title":"bindingMethod","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/challenge\/bindingmethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"When the challenge response includes a "},{"type":"codeVoice","code":"prompt"},{"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."}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","url":"\/documentation\/auth0\/challenge","title":"Challenge"}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth09ChallengeV13bindingMethodSSSgvp","title":"bindingMethod","roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/bindingmethod"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"abstract":[{"type":"text","text":"When the challenge response includes a "},{"type":"codeVoice","code":"prompt"},{"type":"text","text":" binding method, your app needs to prompt the user for the"},{"text":" ","type":"text"},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"url":"\/documentation\/auth0\/challenge","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"abstract":[{"text":"When the challenge response includes a ","type":"text"},{"code":"prompt","type":"codeVoice"},{"type":"text","text":" binding method, your app needs to prompt the user for the"},{"text":" ","type":"text"},{"code":"binding_code","type":"codeVoice"},{"text":" and send it as part of the request.","type":"text"}],"type":"topic","title":"bindingMethod","url":"\/documentation\/auth0\/challenge\/bindingmethod","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 d17cb9ae..5bc1308b 100644 --- a/docs/data/documentation/auth0/challenge/challengetype.json +++ b/docs/data/documentation/auth0/challenge/challengetype.json @@ -1 +1 @@ -{"sections":[],"abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}],"metadata":{"title":"challengeType","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth09ChallengeV13challengeTypeSSvp"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"variants":[{"paths":["\/documentation\/auth0\/challenge\/challengetype"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"title":"challengeType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","kind":"symbol","url":"\/documentation\/auth0\/challenge\/challengetype","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/challenge\/challengetype"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth09ChallengeV13challengeTypeSSvp","symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"challengeType","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"roleHeading":"Instance Property","role":"symbol","title":"challengeType"},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"url":"\/documentation\/auth0\/challenge","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/challenge\/challengetype","title":"challengeType","role":"symbol","abstract":[{"text":"How the user will get the challenge and prove possession.","type":"text"}],"kind":"symbol"}}} \ 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 fcf2782a..3a171db2 100644 --- a/docs/data/documentation/auth0/challenge/init(from:).json +++ b/docs/data/documentation/auth0/challenge/init(from:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/init(from:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"]}]}],"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"symbolKind":"init","modules":[{"name":"Auth0"}],"title":"init(from:)","externalID":"s:5Auth09ChallengeV4fromACs7Decoder_p_tKcfc","role":"symbol","roleHeading":"Initializer"},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"code":"Decodable.init(from:)","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"url":"\/documentation\/auth0\/challenge\/init(from:)","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","title":"init(from:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","url":"\/documentation\/auth0\/challenge","title":"Challenge"}}} \ No newline at end of file +{"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}],"kind":"declarations"}],"metadata":{"externalID":"s:5Auth09ChallengeV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol","title":"init(from:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/challenge\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"url":"\/documentation\/auth0\/challenge","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"role":"symbol","type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"url":"\/documentation\/auth0\/challenge\/init(from:)","abstract":[],"title":"init(from:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"}}} \ 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 b676769d..1ea067a9 100644 --- a/docs/data/documentation/auth0/challenge/oobcode.json +++ b/docs/data/documentation/auth0/challenge/oobcode.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"oobCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"kind":"symbol","sections":[],"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":"Out-of-Band (OOB) code."}],"metadata":{"externalID":"s:5Auth09ChallengeV7oobCodeSSSgvp","title":"oobCode","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"oobCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"variants":[{"paths":["\/documentation\/auth0\/challenge\/oobcode"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","abstract":[{"type":"text","text":"Out-of-Band (OOB) code."}],"title":"oobCode","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"oobCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/challenge\/oobcode"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"oobCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"oobCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","externalID":"s:5Auth09ChallengeV7oobCodeSSSgvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"oobCode"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode"},"variants":[{"paths":["\/documentation\/auth0\/challenge\/oobcode"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"abstract":[{"type":"text","text":"Out-of-Band (OOB) code."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"url":"\/documentation\/auth0\/challenge","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"role":"symbol","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"oobCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/challenge\/oobcode","abstract":[{"text":"Out-of-Band (OOB) code.","type":"text"}],"title":"oobCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials.json b/docs/data/documentation/auth0/credentials.json index 2713a8b3..54371c2b 100644 --- a/docs/data/documentation/auth0/credentials.json +++ b/docs/data/documentation/auth0/credentials.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"attribute","text":"@objc"},{"text":"(A0Credentials) ","kind":"text"},{"kind":"keyword","text":"final"},{"text":" ","kind":"text"},{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials"]}],"sections":[],"metadata":{"title":"Credentials","externalID":"c:@M@Auth0@objc(cs)A0Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"symbolKind":"class","roleHeading":"Class","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","modules":[{"name":"Auth0"}]},"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":[{"identifiers":["doc:\/\/com.auth0.Auth0\/objc(cs)NSObject"],"title":"Inherits From","kind":"relationships","type":"inheritsFrom"},{"kind":"relationships","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"],"title":"Conforms To"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"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"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/credentials\/recoverycode","title":"recoveryCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/objc(pl)NSSecureCoding":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSSecureCoding","title":"Foundation.NSSecureCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"kind":"article","role":"collectionGroup","title":"NSCoding Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","abstract":[]},"doc://com.auth0.Auth0/SH":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SH","title":"Swift.Hashable"},"doc://com.auth0.Auth0/s7CVarArgP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s7CVarArgP","title":"Swift.CVarArg"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/Decodable-Implementations":{"kind":"article","role":"collectionGroup","title":"Decodable Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/decodable-implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"kind":"article","role":"collectionGroup","title":"NSSecureCoding Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","abstract":[]},"doc://com.auth0.Auth0/objc(pl)NSCoding":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSCoding","title":"Foundation.NSCoding"},"doc://com.auth0.Auth0/objc(pl)NSObject":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSObject","title":"ObjectiveC.NSObjectProtocol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"kind":"symbol","role":"symbol","title":"idToken","type":"topic","url":"\/documentation\/auth0\/credentials\/idtoken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"idToken","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Token that contains the user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken"},"doc://com.auth0.Auth0/objc(cs)NSObject":{"identifier":"doc:\/\/com.auth0.Auth0\/objc(cs)NSObject","title":"ObjectiveC.NSObject","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"kind":"symbol","role":"symbol","title":"tokenType","type":"topic","url":"\/documentation\/auth0\/credentials\/tokentype","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"tokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"abstract":[{"text":"Type of the access token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"type":"topic","abstract":[{"text":"When the access token expires.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","role":"symbol","url":"\/documentation\/auth0\/credentials\/expiresin","title":"expiresIn","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"code":"","type":"codeVoice"},{"type":"text","text":"."}],"title":"description","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic","url":"\/documentation\/auth0\/credentials\/description","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"kind":"symbol","role":"symbol","title":"scope","type":"topic","url":"\/documentation\/auth0\/credentials\/scope","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"kind":"symbol","role":"symbol","title":"refreshToken","type":"topic","url":"\/documentation\/auth0\/credentials\/refreshtoken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"accessToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"idToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"recoveryCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"type":"topic","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","abstract":[{"text":"Default initializer.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/accessToken":{"url":"\/documentation\/auth0\/credentials\/accesstoken","role":"symbol","kind":"symbol","title":"accessToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"accessToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Token that can be used to make authenticated requests to the specified API (the "},{"type":"strong","inlineContent":[{"type":"text","text":"audience"}]},{"text":" value used on login).","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"attribute","text":"@objc"},{"kind":"text","text":"(A0Credentials) "},{"text":"final","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","interfaceLanguage":"swift"},"relationshipsSections":[{"title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/objc(cs)NSObject"],"type":"inheritsFrom","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"],"type":"conformsTo","title":"Conforms To","kind":"relationships"}],"kind":"symbol","topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"]},{"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":"Instance Properties"},{"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}],"variants":[{"paths":["\/documentation\/auth0\/credentials"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"metadata":{"role":"symbol","title":"Credentials","modules":[{"name":"Auth0"}],"externalID":"c:@M@Auth0@objc(cs)A0Credentials","symbolKind":"class","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Credentials"}],"navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"roleHeading":"Class"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/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"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials\/accesstoken","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","title":"accessToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"role":"symbol","kind":"symbol","abstract":[{"text":"Token that can be used to request a new access token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","title":"refreshToken","url":"\/documentation\/auth0\/credentials\/refreshtoken"},"doc://com.auth0.Auth0/objc(pl)NSSecureCoding":{"identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSSecureCoding","type":"unresolvable","title":"Foundation.NSSecureCoding"},"doc://com.auth0.Auth0/objc(cs)NSObject":{"identifier":"doc:\/\/com.auth0.Auth0\/objc(cs)NSObject","type":"unresolvable","title":"ObjectiveC.NSObject"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"title":"recoveryCode","type":"topic","abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"url":"\/documentation\/auth0\/credentials\/recoverycode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"recoveryCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"url":"\/documentation\/auth0\/credentials\/expiresin","title":"expiresIn","abstract":[{"type":"text","text":"When the access token expires."}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/objc(pl)NSCoding":{"identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSCoding","type":"unresolvable","title":"Foundation.NSCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"url":"\/documentation\/auth0\/credentials\/idtoken","abstract":[{"text":"Token that contains the user information.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"idToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"idToken","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"expiresIn"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","kind":"symbol","abstract":[{"type":"text","text":"Default initializer."}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"abstract":[],"role":"collectionGroup","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","title":"NSCoding Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","kind":"article","type":"topic"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","type":"unresolvable","title":"Swift.CustomStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"kind":"symbol","role":"symbol","title":"scope","url":"\/documentation\/auth0\/credentials\/scope","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/credentials\/description","type":"topic","abstract":[{"text":"Custom description that redacts the tokens with ","type":"text"},{"code":"","type":"codeVoice"},{"type":"text","text":"."}],"title":"description","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","kind":"article","role":"collectionGroup","title":"NSSecureCoding Implementations","url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations"},"doc://com.auth0.Auth0/SH":{"identifier":"doc:\/\/com.auth0.Auth0\/SH","type":"unresolvable","title":"Swift.Hashable"},"doc://com.auth0.Auth0/s7CVarArgP":{"identifier":"doc:\/\/com.auth0.Auth0\/s7CVarArgP","type":"unresolvable","title":"Swift.CVarArg"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/Decodable-Implementations":{"url":"\/documentation\/auth0\/credentials\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","title":"Decodable Implementations","type":"topic","abstract":[],"role":"collectionGroup","kind":"article"},"doc://com.auth0.Auth0/objc(pl)NSObject":{"identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSObject","type":"unresolvable","title":"ObjectiveC.NSObjectProtocol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"title":"tokenType","url":"\/documentation\/auth0\/credentials\/tokentype","type":"topic","kind":"symbol","abstract":[{"text":"Type of the access token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"tokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"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/credentials/accesstoken.json b/docs/data/documentation/auth0/credentials/accesstoken.json index 9e86e041..f998c382 100644 --- a/docs/data/documentation/auth0/credentials/accesstoken.json +++ b/docs/data/documentation/auth0/credentials/accesstoken.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"symbolKind":"property","externalID":"s:5Auth011CredentialsC11accessTokenSSvp","title":"accessToken","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/accesstoken"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","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 "},{"inlineContent":[{"type":"text","text":"audience"}],"type":"strong"},{"type":"text","text":" value used on login)."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"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"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"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","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","titleInlineContent":[{"type":"text","text":"Audience"}],"title":"Audience"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/accessToken":{"url":"\/documentation\/auth0\/credentials\/accesstoken","role":"symbol","kind":"symbol","title":"accessToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"accessToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Token that can be used to make authenticated requests to the specified API (the "},{"type":"strong","inlineContent":[{"type":"text","text":"audience"}]},{"text":" value used on login).","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken"},"https://auth0.com/docs/secure/tokens/access-tokens":{"title":"Access Tokens","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","titleInlineContent":[{"type":"text","text":"Access Tokens"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens"}}} \ No newline at end of file +{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/accesstoken"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"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"]}],"sections":[],"metadata":{"roleHeading":"Instance Property","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth011CredentialsC11accessTokenSSvp","title":"accessToken","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"abstract":[{"type":"text","text":"Token that can be used to make authenticated requests to the specified API (the "},{"type":"strong","inlineContent":[{"type":"text","text":"audience"}]},{"text":" value used on login).","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"accessToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/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"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials\/accesstoken","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","title":"accessToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"https://auth0.com/docs/secure/tokens/access-tokens/get-access-tokens#control-access-token-audience":{"title":"Audience","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","titleInlineContent":[{"type":"text","text":"Audience"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","type":"link"},"https://auth0.com/docs/secure/tokens/access-tokens":{"titleInlineContent":[{"type":"text","text":"Access Tokens"}],"title":"Access Tokens","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 2415697b..5016cd75 100644 --- a/docs/data/documentation/auth0/credentials/decodable-implementations.json +++ b/docs/data/documentation/auth0/credentials/decodable-implementations.json @@ -1 +1 @@ -{"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","interfaceLanguage":"swift"},"sections":[],"metadata":{"role":"collectionGroup","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"Decodable Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"kind":"article","schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/decodable-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","title":"init(from:)","type":"topic","role":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"url":"\/documentation\/auth0\/credentials\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"],"generated":true,"title":"Initializers"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/decodable-implementations"]}],"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Decodable Implementations"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","title":"init(from:)","url":"\/documentation\/auth0\/credentials\/init(from:)","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 e280c9dc..c70ab4c9 100644 --- a/docs/data/documentation/auth0/credentials/description.json +++ b/docs/data/documentation/auth0/credentials/description.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"override"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"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\/Credentials"]]},"abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"code":"","type":"codeVoice"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentials\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"externalID":"c:@M@Auth0@objc(cs)A0Credentials(py)description","title":"description","symbolKind":"property","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"code":"","type":"codeVoice"},{"type":"text","text":"."}],"title":"description","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic","url":"\/documentation\/auth0\/credentials\/description","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"override"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"description","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"description"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","externalID":"c:@M@Auth0@objc(cs)A0Credentials(py)description","title":"description"},"variants":[{"paths":["\/documentation\/auth0\/credentials\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/credentials\/description","type":"topic","abstract":[{"text":"Custom description that redacts the tokens with ","type":"text"},{"code":"","type":"codeVoice"},{"type":"text","text":"."}],"title":"description","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 fb80e36c..63d3b1e7 100644 --- a/docs/data/documentation/auth0/credentials/encode(with:).json +++ b/docs/data/documentation/auth0/credentials/encode(with:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/encode(with:)"]}],"schemaVersion":{"minor":3,"major":0,"patch":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"]]},"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"},"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"aCoder"},{"kind":"text","text":": "},{"text":"NSCoder","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder"},{"kind":"text","text":")"}]}],"kind":"declarations"}],"metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"encode","kind":"identifier"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NSCoder","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder"},{"text":")","kind":"text"}],"title":"encode(with:)","externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)encodeWithCoder:","roleHeading":"Instance Method","symbolKind":"method","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"kind":"article","role":"collectionGroup","title":"NSCoding Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"text":" encoding method.","type":"text"}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"encode","kind":"identifier"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","kind":"symbol","role":"symbol","title":"encode(with:)","url":"\/documentation\/auth0\/credentials\/encode(with:)"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/credentials\/encode(with:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"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"]]},"abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" encoding method."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":" "},{"text":"aCoder","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"role":"symbol","extendedModule":"Auth0","symbolKind":"method","externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)encodeWithCoder:","modules":[{"name":"Auth0"}],"title":"encode(with:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder"},{"text":")","kind":"text"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","kind":"symbol","url":"\/documentation\/auth0\/credentials\/encode(with:)","title":"encode(with:)","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier","text":"NSCoder"},{"kind":"text","text":")"}],"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"abstract":[],"role":"collectionGroup","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","title":"NSCoding Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","kind":"article","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"}}} \ 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 9d045ca5..cd6a92cf 100644 --- a/docs/data/documentation/auth0/credentials/expiresin.json +++ b/docs/data/documentation/auth0/credentials/expiresin.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}]}]}],"abstract":[{"type":"text","text":"When the access token expires."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/expiresin"]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"externalID":"s:5Auth011CredentialsC9expiresIn10Foundation4DateVvp","role":"symbol","roleHeading":"Instance Property","title":"expiresIn","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"type":"topic","abstract":[{"text":"When the access token expires.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","role":"symbol","url":"\/documentation\/auth0\/credentials\/expiresin","title":"expiresIn","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"sections":[],"abstract":[{"text":"When the access token expires.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn"},"metadata":{"role":"symbol","externalID":"s:5Auth011CredentialsC9expiresIn10Foundation4DateVvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"}],"title":"expiresIn"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/expiresin"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"url":"\/documentation\/auth0\/credentials\/expiresin","title":"expiresIn","abstract":[{"type":"text","text":"When the access token expires."}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","type":"topic"}}} \ 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 3f22c4a1..d700f12d 100644 --- a/docs/data/documentation/auth0/credentials/idtoken.json +++ b/docs/data/documentation/auth0/credentials/idtoken.json @@ -1 +1 @@ -{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"],"title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"idToken","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"name":"Important","style":"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"},{"type":"text","text":" "},{"text":"client","type":"text"}]},{"text":", including the ones received when renewing the credentials using the refresh token. You must","type":"text"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens"},{"type":"text","text":" any ID tokens received from the"},{"text":" ","type":"text"},{"type":"text","text":"Authentication API client before using the information they contain."}],"type":"paragraph"}],"type":"aside"}]}],"abstract":[{"type":"text","text":"Token that contains the user information."}],"sections":[],"metadata":{"title":"idToken","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth011CredentialsC7idTokenSSvp","role":"symbol"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/idtoken"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"kind":"symbol","role":"symbol","title":"idToken","type":"topic","url":"\/documentation\/auth0\/credentials\/idtoken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"idToken","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Token that contains the user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"type":"text","text":"ID Tokens"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","title":"ID Tokens","type":"link"},"https://auth0.com/docs/secure/tokens/id-tokens/validate-id-tokens":{"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","titleInlineContent":[{"type":"text","text":"validate"}],"title":"validate","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens"}}} \ No newline at end of file +{"abstract":[{"text":"Token that contains the user information.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/idtoken"]}],"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\/idToken"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"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"},{"text":" ","type":"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"},{"type":"text","text":" "},{"text":"client","type":"text"}]},{"text":", including the ones received when renewing the credentials using the refresh token. You must","type":"text"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens"},{"text":" any ID tokens received from the","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Authentication API client before using the information they contain."}]}],"type":"aside","style":"important"}],"kind":"content"}],"metadata":{"symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth011CredentialsC7idTokenSSvp","roleHeading":"Instance Property","title":"idToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"https://auth0.com/docs/secure/tokens/id-tokens/validate-id-tokens":{"title":"validate","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","titleInlineContent":[{"text":"validate","type":"text"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"link","title":"ID Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"text":"ID Tokens","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"url":"\/documentation\/auth0\/credentials\/idtoken","abstract":[{"text":"Token that contains the user information.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"idToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"idToken","type":"topic","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 1d81090e..a8b36d60 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 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"text":"accessToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" = \"\", ","kind":"text"},{"kind":"externalParam","text":"tokenType"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" = \"\", "},{"text":"idToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" = \"\", ","kind":"text"},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? = nil, ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"kind":"text","text":" = Date(), "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil)"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)"]}],"metadata":{"title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","role":"symbol","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"accessToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"idToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"expiresIn"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"recoveryCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?)"}],"externalID":"s:5Auth011CredentialsC11accessToken9tokenType02idD007refreshD09expiresIn5scope12recoveryCodeACSS_S3SSg10Foundation4DateVA2Ktcfc","roleHeading":"Initializer","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Default initializer."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"accessToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"idToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"recoveryCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"type":"topic","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","abstract":[{"text":"Default initializer.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Initializer","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"accessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"tokenType","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"idToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"refreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"recoveryCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?)","kind":"text"}],"title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","symbolKind":"init","externalID":"s:5Auth011CredentialsC11accessToken9tokenType02idD007refreshD09expiresIn5scope12recoveryCodeACSS_S3SSg10Foundation4DateVA2Ktcfc"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"accessToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" = \"\", "},{"kind":"externalParam","text":"tokenType"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" = \"\", "},{"text":"idToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"\", "},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"text":"expiresIn","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":" = Date(), ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"text":"recoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil)","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"abstract":[{"type":"text","text":"Default initializer."}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"expiresIn"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","kind":"symbol","abstract":[{"type":"text","text":"Default initializer."}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"}}} \ 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 33c8c4a8..b73acc41 100644 --- a/docs/data/documentation/auth0/credentials/init(coder:).json +++ b/docs/data/documentation/auth0/credentials/init(coder:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"convenience","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"text":"coder","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"aDecoder","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","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"]]},"metadata":{"title":"init(coder:)","modules":[{"name":"Auth0"}],"symbolKind":"init","role":"symbol","extendedModule":"Auth0","externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)initWithCoder:","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"kind":"text","text":": "},{"text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier"},{"kind":"text","text":")"}],"roleHeading":"Initializer"},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" decoding initializer."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(coder:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"coder"},{"kind":"text","text":": "},{"text":"NSCoder","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder"},{"text":")","kind":"text"}],"title":"init(coder:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","url":"\/documentation\/auth0\/credentials\/init(coder:)","type":"topic","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" decoding initializer."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"kind":"article","role":"collectionGroup","title":"NSCoding Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"role":"symbol","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"text":"coder","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier","text":"NSCoder"},{"text":")","kind":"text"}],"roleHeading":"Initializer","title":"init(coder:)","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)initWithCoder:"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"convenience","kind":"keyword"},{"kind":"text","text":" "},{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"aDecoder","kind":"internalParam"},{"kind":"text","text":": "},{"text":"NSCoder","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder"},{"text":")","kind":"text"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/init(coder:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"text":" decoding initializer.","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","interfaceLanguage":"swift"},"sections":[],"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"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"abstract":[],"role":"collectionGroup","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","title":"NSCoding Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","kind":"article","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"text":" decoding initializer.","type":"text"}],"kind":"symbol","type":"topic","role":"symbol","title":"init(coder:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"kind":"text","text":": "},{"text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentials\/init(coder:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 601f1891..53c2fb39 100644 --- a/docs/data/documentation/auth0/credentials/init(from:).json +++ b/docs/data/documentation/auth0/credentials/init(from:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"convenience"},{"kind":"text","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","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations"]]},"metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","roleHeading":"Initializer","externalID":"s:5Auth011CredentialsC4fromACs7Decoder_p_tKcfc","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"symbolKind":"init","title":"init(from:)","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/Decodable-Implementations":{"kind":"article","role":"collectionGroup","title":"Decodable Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/decodable-implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","title":"init(from:)","type":"topic","role":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"url":"\/documentation\/auth0\/credentials\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","interfaceLanguage":"swift"},"abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"convenience","kind":"keyword"},{"kind":"text","text":" "},{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"roleHeading":"Initializer","externalID":"s:5Auth011CredentialsC4fromACs7Decoder_p_tKcfc","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"init(from:)","role":"symbol"},"kind":"symbol","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"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","title":"init(from:)","url":"\/documentation\/auth0\/credentials\/init(from:)","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/Decodable-Implementations":{"url":"\/documentation\/auth0\/credentials\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","title":"Decodable Implementations","type":"topic","abstract":[],"role":"collectionGroup","kind":"article"}}} \ 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 9cbf41ee..226a5e7f 100644 --- a/docs/data/documentation/auth0/credentials/nscoding-implementations.json +++ b/docs/data/documentation/auth0/credentials/nscoding-implementations.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/nscoding-implementations"]}],"sections":[],"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations"},"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"NSCoding Implementations","role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)"],"title":"Initializers","generated":true},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"],"generated":true}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"coder"},{"kind":"text","text":": "},{"text":"NSCoder","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder"},{"text":")","kind":"text"}],"title":"init(coder:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","url":"\/documentation\/auth0\/credentials\/init(coder:)","type":"topic","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" decoding initializer."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"text":" encoding method.","type":"text"}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"encode","kind":"identifier"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","kind":"symbol","role":"symbol","title":"encode(with:)","url":"\/documentation\/auth0\/credentials\/encode(with:)"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/nscoding-implementations"]}],"kind":"article","topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)"],"generated":true},{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"],"title":"Instance Methods"}],"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","roleHeading":"API Collection","title":"NSCoding Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","kind":"symbol","url":"\/documentation\/auth0\/credentials\/encode(with:)","title":"encode(with:)","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier","text":"NSCoder"},{"kind":"text","text":")"}],"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"text":" decoding initializer.","type":"text"}],"kind":"symbol","type":"topic","role":"symbol","title":"init(coder:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"kind":"text","text":": "},{"text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentials\/init(coder:)"}}} \ 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 644b5e4f..991e79ad 100644 --- a/docs/data/documentation/auth0/credentials/nssecurecoding-implementations.json +++ b/docs/data/documentation/auth0/credentials/nssecurecoding-implementations.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/nssecurecoding-implementations"]}],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Type Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"]}],"metadata":{"title":"NSSecureCoding Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"supportsSecureCoding"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"type":"codeVoice","code":"true"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentials\/supportssecurecoding","title":"supportsSecureCoding"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup","title":"NSSecureCoding Implementations"},"variants":[{"paths":["\/documentation\/auth0\/credentials\/nssecurecoding-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"article","schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"topicSections":[{"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"],"generated":true}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"url":"\/documentation\/auth0\/credentials\/supportssecurecoding","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"supportsSecureCoding","abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"type":"codeVoice","code":"true"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"}}} \ 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 2c1ed44c..26385aca 100644 --- a/docs/data/documentation/auth0/credentials/recoverycode.json +++ b/docs/data/documentation/auth0/credentials/recoverycode.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/recoverycode"]}],"sections":[],"metadata":{"title":"recoveryCode","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoveryCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth011CredentialsC12recoveryCodeSSSgvp"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/credentials\/recoverycode","title":"recoveryCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode"},"https://auth0.com/docs/secure/multi-factor-authentication/configure-recovery-codes-for-mfa":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa","title":"MFA Recovery Codes","url":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa","titleInlineContent":[{"text":"MFA Recovery Codes","type":"text"}]}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","symbolKind":"property","externalID":"s:5Auth011CredentialsC12recoveryCodeSSSgvp","title":"recoveryCode"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"abstract":[{"text":"MFA recovery code that the application must display to the user, to be stored securely for future use.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/recoverycode"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"title":"recoveryCode","type":"topic","abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"url":"\/documentation\/auth0\/credentials\/recoverycode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"recoveryCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"kind":"symbol","role":"symbol"},"https://auth0.com/docs/secure/multi-factor-authentication/configure-recovery-codes-for-mfa":{"type":"link","title":"MFA Recovery Codes","titleInlineContent":[{"text":"MFA Recovery Codes","type":"text"}],"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"}}} \ 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 4ab7a8cf..03b75636 100644 --- a/docs/data/documentation/auth0/credentials/refreshtoken.json +++ b/docs/data/documentation/auth0/credentials/refreshtoken.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"externalID":"s:5Auth011CredentialsC12refreshTokenSSSgvp","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"refreshToken","roleHeading":"Instance Property","symbolKind":"property","role":"symbol"},"schemaVersion":{"patch":0,"minor":3,"major":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"refreshToken","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"style":"note","type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"The scope ","type":"text"},{"code":"offline_access","type":"codeVoice"},{"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"}]},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","isActive":true,"type":"reference"},{"type":"text","text":"."},{"text":" ","type":"text"},{"text":"If you are also specifying an audience value, make sure that the corresponding Auth0 API has the","type":"text"},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"text","text":"Allow Offline Access"}]},{"type":"text","text":" "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","type":"reference"},{"text":".","type":"text"}]}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/refreshtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"kind":"symbol","role":"symbol","title":"refreshToken","type":"topic","url":"\/documentation\/auth0\/credentials\/refreshtoken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/get-started/applications/update-grant-types":{"title":"grant enabled","titleInlineContent":[{"type":"text","text":"grant enabled"}],"type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types"},"https://auth0.com/docs/get-started/apis/api-settings#access-settings":{"title":"setting enabled","titleInlineContent":[{"text":"setting enabled","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]}}} \ No newline at end of file +{"kind":"symbol","metadata":{"role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"externalID":"s:5Auth011CredentialsC12refreshTokenSSSgvp","title":"refreshToken","symbolKind":"property"},"variants":[{"paths":["\/documentation\/auth0\/credentials\/refreshtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"refreshToken","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","style":"note","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"code":"offline_access","type":"codeVoice"},{"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":[{"type":"text","text":"refresh token"}]},{"text":" ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types"},{"text":".","type":"text"},{"type":"text","text":" "},{"type":"text","text":"If you are also specifying an audience value, make sure that the corresponding Auth0 API has the"},{"type":"text","text":" "},{"inlineContent":[{"text":"Allow Offline Access","type":"text"}],"type":"strong"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","type":"reference"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","type":"link","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"https://auth0.com/docs/get-started/applications/update-grant-types":{"type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","titleInlineContent":[{"type":"text","text":"grant enabled"}],"title":"grant enabled","identifier":"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","title":"setting enabled","type":"link","titleInlineContent":[{"text":"setting enabled","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"role":"symbol","kind":"symbol","abstract":[{"text":"Token that can be used to request a new access token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","title":"refreshToken","url":"\/documentation\/auth0\/credentials\/refreshtoken"}}} \ 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 efe0290a..cea964e5 100644 --- a/docs/data/documentation/auth0/credentials/scope.json +++ b/docs/data/documentation/auth0/credentials/scope.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]}]}],"metadata":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth011CredentialsC5scopeSSSgvp","title":"scope"},"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/scope"]}],"abstract":[{"text":"The scopes that have been granted by Auth0.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"kind":"symbol","role":"symbol","title":"scope","type":"topic","url":"\/documentation\/auth0\/credentials\/scope","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/get-started/apis/scopes":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","titleInlineContent":[{"type":"text","text":"Scopes"}],"url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","title":"Scopes","type":"link"}}} \ No newline at end of file +{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"scope","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]}],"metadata":{"role":"symbol","title":"scope","roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth011CredentialsC5scopeSSSgvp","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"scope","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/scope"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"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/Credentials/scope":{"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"kind":"symbol","role":"symbol","title":"scope","url":"\/documentation\/auth0\/credentials\/scope","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope"}}} \ 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 9dbdc0dd..59939d4e 100644 --- a/docs/data/documentation/auth0/credentials/supportssecurecoding.json +++ b/docs/data/documentation/auth0/credentials/supportssecurecoding.json @@ -1 +1 @@ -{"sections":[],"abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"type":"codeVoice","code":"true"},{"text":".","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/credentials\/supportssecurecoding"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","roleHeading":"Type Property","title":"supportsSecureCoding","externalID":"c:@CM@Auth0@objc(cs)A0Credentials(cpy)supportsSecureCoding","modules":[{"name":"Auth0"}],"symbolKind":"property","extendedModule":"Auth0","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"kind":"symbol","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\/NSSecureCoding-Implementations"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"supportsSecureCoding"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"supportsSecureCoding"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"type":"codeVoice","code":"true"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentials\/supportssecurecoding","title":"supportsSecureCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"kind":"article","role":"collectionGroup","title":"NSSecureCoding Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"supportsSecureCoding"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations"]]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"type":"codeVoice","code":"true"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/supportssecurecoding"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"},"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","externalID":"c:@CM@Auth0@objc(cs)A0Credentials(cpy)supportsSecureCoding","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"supportsSecureCoding"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"supportsSecureCoding","extendedModule":"Auth0","roleHeading":"Type Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","kind":"article","role":"collectionGroup","title":"NSSecureCoding Implementations","url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"url":"\/documentation\/auth0\/credentials\/supportssecurecoding","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"supportsSecureCoding","abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"type":"codeVoice","code":"true"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"}}} \ 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 35494df9..fce174d0 100644 --- a/docs/data/documentation/auth0/credentials/tokentype.json +++ b/docs/data/documentation/auth0/credentials/tokentype.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tokenType","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Type of the access token.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentials\/tokentype"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType"},"metadata":{"title":"tokenType","roleHeading":"Instance Property","externalID":"s:5Auth011CredentialsC9tokenTypeSSvp","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"kind":"symbol","role":"symbol","title":"tokenType","type":"topic","url":"\/documentation\/auth0\/credentials\/tokentype","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"tokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"abstract":[{"text":"Type of the access token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]}}} \ No newline at end of file +{"kind":"symbol","abstract":[{"type":"text","text":"Type of the access token."}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth011CredentialsC9tokenTypeSSvp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"tokenType","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"symbolKind":"property","role":"symbol","roleHeading":"Instance Property","title":"tokenType"},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/credentials\/tokentype"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"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\/tokenType"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"tokenType","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"title":"tokenType","url":"\/documentation\/auth0\/credentials\/tokentype","type":"topic","kind":"symbol","abstract":[{"text":"Type of the access token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"tokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager.json b/docs/data/documentation/auth0/credentialsmanager.json index 6fc4d053..229cc2e7 100644 --- a/docs/data/documentation/auth0/credentialsmanager.json +++ b/docs/data/documentation/auth0/credentialsmanager.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"sections":[],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"],"title":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"],"title":"Instance Properties"},{"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"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"languages":["swift"]}]},{"content":[{"type":"heading","anchor":"overview","text":"Overview","level":2},{"name":"Warning","style":"warning","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The Credentials Manager is not thread-safe, except for its"},{"text":" ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","isActive":true,"type":"reference"},{"text":" and","type":"text"},{"text":" ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},{"text":" methods. To avoid concurrency issues, do not call its","type":"text"},{"type":"text","text":" "},{"text":"non thread-safe methods and properties from different threads without proper synchronization.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"externalID":"s:5Auth018CredentialsManagerV","modules":[{"name":"Auth0"}],"roleHeading":"Structure","title":"CredentialsManager"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"type":"topic","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":" "},{"text":"the specified TTL. If you are not using refresh tokens, use this method instead of ","type":"text"},{"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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","title":"hasValid(minTTL:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","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"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","abstract":[{"text":"Calls the ","type":"text"},{"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"},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error."}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","title":"revoke(headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"}],"kind":"symbol","title":"credentials(withScope:minTTL:parameters:headers:)","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, return the retrieved credentials as they are not expired. Renewed credentials will be"},{"type":"text","text":" "},{"type":"text","text":"stored in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enableBiometrics"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"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"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"evaluationPolicy","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","role":"symbol","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"kind":"symbol","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"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and an error is thrown.","type":"text"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"title":"revoke(headers:)","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"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"}]},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"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"},{"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"}],"role":"symbol","type":"topic","kind":"symbol","title":"renew(parameters:headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"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"},{"type":"text","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"},{"text":"result containing a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","isActive":true,"type":"reference"},{"type":"text","text":" error."}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"], (","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","title":"revoke(headers:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"url":"\/documentation\/auth0\/credentialsmanager\/user","identifier":"doc:\/\/com.auth0.Auth0\/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"},{"text":"The user information is read from the stored ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"text":".","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":"?","kind":"text"}],"kind":"symbol","type":"topic","role":"symbol","title":"user"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","title":"credentials(withScope:minTTL:parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":", ","kind":"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"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","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"},{"text":"Renewed credentials will be stored in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"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"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","type":"topic","title":"renew(parameters:headers:callback:)"},"https://auth0.com/docs/secure/tokens/id-tokens":{"titleInlineContent":[{"type":"text","text":"ID token"}],"title":"ID token","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/credentials(withScope:minTTL:parameters:headers:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"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":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"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":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"text":"callback","kind":"externalParam"},{"kind":"text","text":": ("},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"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":" ","type":"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":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","title":"credentials(withScope:minTTL:parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clear","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","abstract":[{"text":"Clears credentials stored in the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/clear()","title":"clear()"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"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"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"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"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","type":"topic","title":"renew(parameters:headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"title":"revokeFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","abstract":[{"type":"text","text":"The revocation of the refresh token 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"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","type":"topic","abstract":[{"text":"Creates a new ","type":"text"},{"code":"CredentialsManager","type":"codeVoice"},{"text":" instance.","type":"text"}],"role":"symbol","title":"init(authentication:storeKey:storage:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"type":"topic","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 "},{"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"},{"text":" ","type":"text"},{"type":"text","text":"starts up."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","title":"canRenew()","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"canRenew","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","type":"topic","title":"store(credentials:)","kind":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","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"]},{"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"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","anchor":"overview","text":"Overview","level":2},{"name":"Warning","style":"warning","type":"aside","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},{"type":"text","text":" and"},{"text":" ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},{"type":"text","text":" methods. To avoid concurrency issues, do not call its"},{"text":" ","type":"text"},{"type":"text","text":"non thread-safe methods and properties from different threads without proper synchronization."}]}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager"]}],"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"externalID":"s:5Auth018CredentialsManagerV","symbolKind":"struct","roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"role":"symbol","title":"CredentialsManager"},"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."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","type":"topic","title":"renew(parameters:headers:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"topic","title":"store(credentials:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"revokeFailed","abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"type":"reference","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","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","title":"revoke(headers:)","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 an error is thrown.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"authentication"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier","text":"Authentication"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storage"},{"text":": ","kind":"text"},{"text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":")"}],"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","title":"init(authentication:storeKey:storage:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"CredentialsManager","type":"codeVoice"},{"type":"text","text":" instance."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","title":"credentials(withScope:minTTL:parameters:headers:)","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 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"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"], ("},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","title":"revoke(headers:_:)","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 will not be cleared and the callback will be called with a failure"},{"type":"text","text":" "},{"type":"text","text":"result containing a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed"},{"text":" error.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"title":"revoke(headers:)","role":"symbol","abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"type":"text","text":" "},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"cancelTitle"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"fallbackTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"evaluationPolicy"},{"kind":"text","text":": "},{"text":"LAPolicy","preciseIdentifier":"c:@E@LAPolicy","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","role":"symbol","abstract":[{"text":"Enables biometric authentication for additional security during credentials retrieval.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}],"title":"renew(parameters:headers:callback:)","role":"symbol","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","role":"symbol","title":"canRenew()","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"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:)","type":"reference","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"text":" ","type":"text"},{"text":"starts up.","type":"text"}]},"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","title":"ID token","titleInlineContent":[{"text":"ID token","type":"text"}]},"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:)","role":"symbol","title":"credentials(withScope:minTTL:parameters:headers:callback:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","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"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"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."},{"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","role":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/user","kind":"symbol","title":"user","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"text":": ","kind":"text"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired."},{"text":" ","type":"text"},{"text":"The user information is read from the stored ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","role":"symbol","type":"topic","title":"credentials(withScope:minTTL:parameters:headers:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"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"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}],"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. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","kind":"symbol","title":"hasValid(minTTL:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"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"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"type":"text","text":" to"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","role":"symbol","type":"topic","title":"clear()","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/clear()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","role":"symbol","type":"topic","title":"renew(parameters:headers:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"text":"(","kind":"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"},{"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"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"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"}]}}} \ 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 b7af12c8..b822f8c1 100644 --- a/docs/data/documentation/auth0/credentialsmanager/canrenew().json +++ b/docs/data/documentation/auth0/credentialsmanager/canrenew().json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth018CredentialsManagerV8canRenewSbyF","modules":[{"name":"Auth0"}],"role":"symbol","title":"canRenew()","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"canRenew"},{"kind":"text","text":"() -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"symbolKind":"method"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/canrenew()"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using"},{"text":" ","type":"text"},{"text":"refresh tokens, use this method instead of ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true},{"text":" to check for stored credentials when your app","type":"text"},{"text":" ","type":"text"},{"text":"starts up.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"If there are credentials stored containing a refresh token.","type":"text"}]}]},{"content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"code":["guard credentialsManager.canRenew() else {"," \/\/ No renewable credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"],"type":"codeListing","syntax":"swift"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"type":"topic","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":" "},{"text":"the specified TTL. If you are not using refresh tokens, use this method instead of ","type":"text"},{"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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","title":"hasValid(minTTL:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","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"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"type":"topic","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 "},{"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"},{"text":" ","type":"text"},{"type":"text","text":"starts up."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","title":"canRenew()","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"canRenew","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"canRenew()","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV8canRenewSbyF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"roleHeading":"Instance Method"},"schemaVersion":{"minor":3,"patch":0,"major":0},"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","type":"reference"},{"type":"text","text":" to check for stored credentials when your app"},{"text":" ","type":"text"},{"type":"text","text":"starts up."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/canrenew()"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If there are credentials stored containing a refresh token."}]}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"code":["guard credentialsManager.canRenew() else {"," \/\/ No renewable credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"],"type":"codeListing","syntax":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","role":"symbol","title":"canRenew()","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"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:)","type":"reference","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"text":" ","type":"text"},{"text":"starts up.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","kind":"symbol","title":"hasValid(minTTL:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"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"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"type":"text","text":" to"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]}}} \ 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 eaef463d..4848d72c 100644 --- a/docs/data/documentation/auth0/credentialsmanager/clear().json +++ b/docs/data/documentation/auth0/credentialsmanager/clear().json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"If the credentials were removed."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["let didClear = credentialsManager.clear()"]}]}],"sections":[],"kind":"symbol","abstract":[{"text":"Clears credentials stored in the Keychain.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"title":"clear()","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV5clearSbyF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/clear()"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clear","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","abstract":[{"text":"Clears credentials stored in the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/clear()","title":"clear()"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the credentials were removed."}]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"code":["let didClear = credentialsManager.clear()"],"type":"codeListing","syntax":"swift"}]}],"kind":"symbol","metadata":{"symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV5clearSbyF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"clear()","roleHeading":"Instance Method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/clear()"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","role":"symbol","type":"topic","title":"clear()","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/clear()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}]}}} \ 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 11e2df8a..21fe0efa 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 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":" "},{"text":"scope","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":" = 0, ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"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"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","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"}]}],"name":"scope"},{"name":"minTTL","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to "},{"code":"0","type":"codeVoice"},{"type":"text","text":"."}]}]},{"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":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The user’s credentials."}]}]},{"content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["do {"," let credentials = try await credentialsManager.credentials()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["let credentials = try await credentialsManager.credentials(minTTL: 60)"]},{"inlineContent":[{"text":"If you need to specify custom parameters or headers for the credentials renewal:","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["let credentials = try await credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"]},{"type":"paragraph","inlineContent":[{"text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested","type":"text"},{"text":" ","type":"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"}]},{"type":"codeListing","syntax":"swift","code":["let credentials = try await credentialsManager.credentials(scope: \"openid offline_access\")"]},{"style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error of type "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","isActive":true},{"text":".","type":"text"}]}],"name":"Throws"},{"type":"aside","style":"note","name":"Requires","content":[{"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"},{"type":"text","text":" "},{"text":"the credentials are expired and there is no refresh token, a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error"},{"text":" ","type":"text"},{"text":"will be thrown.","type":"text"}],"type":"paragraph"}]},{"name":"Warning","content":[{"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"},{"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:)"},{"type":"text","text":" is not, calling it anyway can"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"warning"},{"style":"important","type":"aside","name":"Important","content":[{"inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"credentials(withScope:minTTL:parameters:headers:)","role":"symbol","roleHeading":"Instance Method","extendedModule":"Auth0","externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headersAA0B0CSSSg_SiSDySSypGSDyS2SGtYaKF","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"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":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","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"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}]},"sections":[],"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":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","interfaceLanguage":"swift"},"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#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"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."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","title":"noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"}],"kind":"symbol","title":"credentials(withScope:minTTL:parameters:headers:)","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, return the retrieved credentials as they are not expired. Renewed credentials will be"},{"type":"text","text":" "},{"type":"text","text":"stored in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"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"},"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","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"title":"Refresh Tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","type":"topic","title":"store(credentials:)","kind":"symbol"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":" "},{"kind":"internalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":" = 0, ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"] = [:], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"] = [:]) "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"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":"parameters","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"},{"type":"text","text":", which will ask for the same scopes that were requested on login."}]}]},{"name":"minTTL","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"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}]}]},{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use when renewing credentials.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"inlineContent":[{"text":"The user’s credentials.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"code":["do {"," let credentials = try await credentialsManager.credentials()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"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":["let credentials = try await credentialsManager.credentials(minTTL: 60)"]},{"inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers for the credentials renewal:"}],"type":"paragraph"},{"syntax":"swift","code":["let credentials = try await credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"],"type":"codeListing"},{"type":"paragraph","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"},{"type":"text","text":"are expired or not."}]},{"syntax":"swift","code":["let credentials = try await credentialsManager.credentials(scope: \"openid offline_access\")"],"type":"codeListing"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"An error of type ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":".","type":"text"}]}],"type":"aside","name":"Throws"},{"type":"aside","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":"the credentials are expired and there is no refresh token, a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"text":" error","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"will be thrown."}],"type":"paragraph"}],"name":"Requires"},{"style":"warning","content":[{"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:)","isActive":true,"type":"reference"},{"text":" is not, calling it anyway can","type":"text"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}],"type":"paragraph"}],"name":"Warning","type":"aside"},{"style":"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"}],"name":"Important"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"role":"symbol","extendedModule":"Auth0","symbolKind":"method","title":"credentials(withScope:minTTL:parameters:headers:)","externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headersAA0B0CSSSg_SiSDySSypGSDyS2SGtYaKF","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"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":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","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"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"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"},{"text":" ","type":"text"},{"type":"text","text":"stored in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"sections":[],"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"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","role":"symbol","type":"topic","title":"credentials(withScope:minTTL:parameters:headers:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"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"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}],"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. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"topic","title":"store(credentials:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"type":"text","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":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic"}}} \ 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 3a4da3dc..fe191a9b 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 @@ -{"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"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"extendedModule":"Auth0","role":"symbol","title":"credentials(withScope:minTTL:parameters:headers:)","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]) -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSSSg_SiSDySSypGSDyS2SGtF"},"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","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"}],"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."},{"type":"text","text":" "},{"text":"Renewed credentials will be stored 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"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":" ","kind":"text"},{"text":"scope","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":" = 0, ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"] = [:], "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"] = [:]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"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\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"parameters":[{"name":"scope","content":[{"type":"paragraph","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"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to "},{"code":"0","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"minTTL"},{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use when renewing credentials.","type":"text"}]}],"name":"headers"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A type-erased publisher."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","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":"paragraph","inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:","type":"text"}]},{"code":["credentialsManager"," .credentials(minTTL: 60)"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"If you need to specify custom parameters or headers for the credentials renewal:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"type":"paragraph","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"},{"type":"text","text":" "},{"type":"text","text":"are expired or not."}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .credentials(scope: \"openid offline_access\")"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"The scope ","type":"text"},{"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":" "},{"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"},{"type":"aside","name":"Warning","style":"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"},{"text":" ","type":"text"},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"reference"},{"text":" is not, calling it anyway can","type":"text"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}]}]},{"type":"aside","name":"Important","style":"important","content":[{"inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}]}]}],"references":{"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"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."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","title":"noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","type":"topic","title":"store(credentials:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","title":"credentials(withScope:minTTL:parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":", ","kind":"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"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","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"},{"text":"Renewed credentials will be stored in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"type":"topic"}}} \ No newline at end of file +{"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:)-7xldm"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"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"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"credentials(withScope:minTTL:parameters:headers:)","symbolKind":"method","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","roleHeading":"Instance Method","role":"symbol","externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSSSg_SiSDySSypGSDyS2SGtF"},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm"},"sections":[],"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"}],"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"},{"text":" ","kind":"text"},{"text":"scope","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"kind":"text","text":" = 0, "},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"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"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"kind":"text","text":", "},{"text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"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"},{"code":"nil","type":"codeVoice"},{"text":", which will ask for the same scopes that were requested on login.","type":"text"}]}]},{"name":"minTTL","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":"parameters","content":[{"type":"paragraph","inlineContent":[{"text":"Additional parameters to use when renewing credentials.","type":"text"}]}]},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when renewing credentials."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"inlineContent":[{"type":"text","text":"A type-erased publisher."}],"type":"paragraph"}]},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"type":"codeListing","syntax":"swift","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)"]},{"inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager"," .credentials(minTTL: 60)"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers for the credentials renewal:"}]},{"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":" "},{"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"},{"syntax":"swift","code":["credentialsManager"," .credentials(scope: \"openid offline_access\")"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing"},{"style":"note","type":"aside","name":"Requires","content":[{"type":"paragraph","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"},{"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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"type":"text","text":" error."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Do not call ","type":"text"},{"code":"store(credentials:)","type":"codeVoice"},{"text":" afterward. The Credentials Manager automatically persists the","type":"text"},{"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},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}]}],"name":"Warning","style":"warning","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"},{"text":" ","type":"text"},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}]}],"name":"Important","type":"aside","style":"important"}],"kind":"content"}],"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."},{"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":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","title":"credentials(withScope:minTTL:parameters:headers:)","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 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"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","role":"symbol","kind":"symbol"},"https://auth0.com/docs/api/authentication#refresh-token":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"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":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"topic","title":"store(credentials:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"type":"text","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":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic"}}} \ 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 e62b5f9b..374b3093 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 @@ -{"metadata":{"title":"credentials(withScope:minTTL:parameters:headers:callback:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers8callbackySSSg_SiSDySSypGSDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)"],"traits":[{"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"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"scope","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":" = 0, ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"] = [:], "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request when renewing credentials. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":", which will ask for the same scopes that were requested on login."}],"type":"paragraph"}],"name":"scope"},{"name":"minTTL","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":"parameters","content":[{"inlineContent":[{"text":"Additional parameters to use when renewing credentials.","type":"text"}],"type":"paragraph"}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use when renewing credentials."}]}]},{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the user’s credentials or an error."}]}]}]},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"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":[{"text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["credentialsManager.credentials(minTTL: 60) { print($0) }"]},{"inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers for the credentials renewal:"}],"type":"paragraph"},{"code":["credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"],"type":"codeListing","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":" "},{"text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"are expired or not."}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager.credentials(scope: \"openid offline_access\") { print($0) }"]},{"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, the callback will be called with a","type":"text"},{"type":"text","text":" "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true,"type":"reference"},{"text":" error.","type":"text"}],"type":"paragraph"}],"type":"aside"},{"name":"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"},{"text":" ","type":"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"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}]}],"style":"warning","type":"aside"},{"style":"important","type":"aside","name":"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"},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}]}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","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\/CredentialsManager"]]},"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 retrieved credentials will be returned via the success case as they are not expired."},{"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":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","type":"topic","title":"store(credentials:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"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":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"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":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"text":"callback","kind":"externalParam"},{"kind":"text","text":": ("},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"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":" ","type":"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":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","title":"credentials(withScope:minTTL:parameters:headers:callback:)"},"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"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."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","title":"noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"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":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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":": ("},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"credentials(withScope:minTTL:parameters:headers:callback:)","externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers8callbackySSSg_SiSDySSypGSDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","roleHeading":"Instance Method"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"text":" ","type":"text"},{"text":"is expired. Otherwise, the retrieved credentials will be returned via the success case as they are not expired.","type":"text"},{"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":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)"]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":" "},{"text":"scope","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"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"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:], "},{"text":"callback","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}]}]},{"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"},{"text":", which will ask for the same scopes that were requested on login.","type":"text"}]}]},{"name":"minTTL","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"},{"text":".","type":"text"}]}]},{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}]}]},{"content":[{"inlineContent":[{"text":"Additional headers to use when renewing credentials.","type":"text"}],"type":"paragraph"}],"name":"headers"},{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"text":"Callback that receives a ","type":"text"},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the user’s credentials or an error."}]}]}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"syntax":"swift","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"},{"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"},{"code":["credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"],"type":"codeListing","syntax":"swift"},{"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"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["credentialsManager.credentials(scope: \"openid offline_access\") { print($0) }"]},{"content":[{"type":"paragraph","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":"the credentials are expired and there is no refresh token, the callback will be called with a"},{"type":"text","text":" "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true,"type":"reference"},{"text":" error.","type":"text"}]}],"style":"note","name":"Requires","type":"aside"},{"name":"Warning","type":"aside","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":" "},{"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:)"},{"type":"text","text":" is not, calling it anyway can"},{"text":" ","type":"text"},{"type":"text","text":"cause concurrency issues."}],"type":"paragraph"}]},{"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"}],"style":"important","name":"Important"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"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\/credentials(withScope:minTTL:parameters:headers:callback:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"url":"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"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"topic","title":"store(credentials:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","title":"CredentialsManagerResult","type":"topic","url":"\/documentation\/auth0\/credentialsmanagerresult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"kind":"symbol"},"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:)","role":"symbol","title":"credentials(withScope:minTTL:parameters:headers:callback:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","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"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"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."},{"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"type":"text","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":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"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 294719ea..f417257d 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 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"enableBiometrics","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withTitle"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"title"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"fallbackTitle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"evaluationPolicy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy"},{"text":" = .deviceOwnerAuthenticationWithBiometrics)","kind":"text"}],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Main message to display when Face ID or Touch ID is used.","type":"text"}],"type":"paragraph"}],"name":"title"},{"content":[{"inlineContent":[{"type":"text","text":"Cancel message to display when Face ID or Touch ID is used."}],"type":"paragraph"}],"name":"cancelTitle"},{"name":"fallbackTitle","content":[{"inlineContent":[{"type":"text","text":"Fallback message to display when Face ID or Touch ID is used after a failed match."}],"type":"paragraph"}]},{"name":"evaluationPolicy","content":[{"inlineContent":[{"type":"text","text":"Policy to be used for authentication policy evaluation."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID\")"]},{"type":"paragraph","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."}]},{"syntax":"swift","type":"codeListing","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID or passcode\", "," evaluationPolicy: .deviceOwnerAuthentication)"]},{"content":[{"inlineContent":[{"text":"Access to the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","isActive":true,"type":"reference"},{"type":"text","text":" property will not be protected by biometric authentication."}],"type":"paragraph"}],"name":"Important","type":"aside","style":"important"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","externalID":"s:5Auth018CredentialsManagerV16enableBiometrics9withTitle06cancelG008fallbackG016evaluationPolicyySS_SSSgAISo8LAPolicyVtF","roleHeading":"Instance Method","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"fallbackTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"evaluationPolicy","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy"},{"text":")","kind":"text"}]},"abstract":[{"text":"Enables biometric authentication for additional security during credentials retrieval.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"url":"\/documentation\/auth0\/credentialsmanager\/user","identifier":"doc:\/\/com.auth0.Auth0\/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"},{"text":"The user information is read from the stored ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"text":".","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":"?","kind":"text"}],"kind":"symbol","type":"topic","role":"symbol","title":"user"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"url":"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"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enableBiometrics"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"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"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"evaluationPolicy","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","type":"topic","role":"symbol","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"enableBiometrics"},{"kind":"text","text":"("},{"text":"withTitle","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"title","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"evaluationPolicy"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@LAPolicy","kind":"typeIdentifier","text":"LAPolicy"},{"text":" = .deviceOwnerAuthenticationWithBiometrics)","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"title","content":[{"inlineContent":[{"text":"Main message to display when Face ID or Touch ID is used.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Cancel message to display when Face ID or Touch ID is used.","type":"text"}]}],"name":"cancelTitle"},{"name":"fallbackTitle","content":[{"inlineContent":[{"type":"text","text":"Fallback message to display when Face ID or Touch ID is used after a failed match."}],"type":"paragraph"}]},{"name":"evaluationPolicy","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Policy to be used for authentication policy evaluation."}]}]}]},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID\")"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If needed, you can specify a particular "},{"type":"codeVoice","code":"LAPolicy"},{"text":" to be used. For example, you might want to support Face ID or","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Touch ID, but also allow fallback to passcode."}]},{"code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID or passcode\", "," evaluationPolicy: .deviceOwnerAuthentication)"],"type":"codeListing","syntax":"swift"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Access to the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"},{"type":"text","text":" property will not be protected by biometric authentication."}]}],"style":"important","name":"Important"}]}],"metadata":{"roleHeading":"Instance Method","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","externalID":"s:5Auth018CredentialsManagerV16enableBiometrics9withTitle06cancelG008fallbackG016evaluationPolicyySS_SSSgAISo8LAPolicyVtF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"enableBiometrics"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withTitle"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"cancelTitle"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"evaluationPolicy"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@LAPolicy","kind":"typeIdentifier","text":"LAPolicy"},{"kind":"text","text":")"}],"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)"]}],"sections":[],"abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"cancelTitle"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"fallbackTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"evaluationPolicy"},{"kind":"text","text":": "},{"text":"LAPolicy","preciseIdentifier":"c:@E@LAPolicy","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","role":"symbol","abstract":[{"text":"Enables biometric authentication for additional security during credentials retrieval.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","kind":"symbol"},"https://auth0.com/docs/secure/tokens/id-tokens":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","title":"ID token","titleInlineContent":[{"text":"ID token","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","role":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/user","kind":"symbol","title":"user","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"text":": ","kind":"text"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired."},{"text":" ","type":"text"},{"text":"The user information is read from the stored ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"type":"text","text":"."}]}}} \ 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 b1efde7d..460c9e02 100644 --- a/docs/data/documentation/auth0/credentialsmanager/hasvalid(minttl:).json +++ b/docs/data/documentation/auth0/credentialsmanager/hasvalid(minttl:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth018CredentialsManagerV8hasValid6minTTLSbSi_tF","roleHeading":"Instance Method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"hasValid"},{"kind":"text","text":"("},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"modules":[{"name":"Auth0"}],"title":"hasValid(minTTL:)","symbolKind":"method"},"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","type":"reference"},{"type":"text","text":" to"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"hasValid","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":" = 0) -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"minTTL","content":[{"inlineContent":[{"text":"Minimum lifetime in seconds the access token must have left. Defaults to ","type":"text"},{"code":"0","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"If there are credentials stored containing an access token that is neither expired or about to expire.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"type":"codeListing","syntax":"swift","code":["guard credentialsManager.hasValid() else {"," \/\/ No valid credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"]}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"type":"topic","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 "},{"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"},{"text":" ","type":"text"},{"type":"text","text":"starts up."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","title":"canRenew()","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"canRenew","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"type":"topic","abstract":[{"text":"When the access token expires.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","role":"symbol","url":"\/documentation\/auth0\/credentials\/expiresin","title":"expiresIn","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"type":"topic","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":" "},{"text":"the specified TTL. If you are not using refresh tokens, use this method instead of ","type":"text"},{"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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","title":"hasValid(minTTL:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","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"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}}} \ No newline at end of file +{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"hasValid"},{"text":"(","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":" = 0) -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"minTTL","content":[{"inlineContent":[{"text":"Minimum lifetime in seconds the access token must have left. Defaults to ","type":"text"},{"code":"0","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If there are credentials stored containing an access token that is neither expired or about to expire."}]}]},{"kind":"content","content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"code":["guard credentialsManager.hasValid() else {"," \/\/ No valid credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"],"syntax":"swift","type":"codeListing"}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn"]}],"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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","isActive":true},{"type":"text","text":" to"},{"type":"text","text":" "},{"text":"check for stored credentials when your app starts up.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)"},"metadata":{"symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV8hasValid6minTTLSbSi_tF","title":"hasValid(minTTL:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"hasValid","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","role":"symbol","title":"canRenew()","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"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:)","type":"reference","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"text":" ","type":"text"},{"text":"starts up.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","kind":"symbol","title":"hasValid(minTTL:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"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"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"type":"text","text":" to"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"url":"\/documentation\/auth0\/credentials\/expiresin","title":"expiresIn","abstract":[{"type":"text","text":"When the access token expires."}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","type":"topic"}}} \ 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 6c8a8dc0..3534a681 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."}],"metadata":{"symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier","text":"Authentication"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storeKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"storage","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP","text":"CredentialsStorage"},{"text":")","kind":"text"}],"title":"init(authentication:storeKey:storage:)","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","role":"symbol","externalID":"s:5Auth018CredentialsManagerV14authentication8storeKey7storageAcA14Authentication_p_SSAA0B7Storage_ptcfc"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"authentication"},{"text":": ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storeKey"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"credentials\", "},{"text":"storage","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth018CredentialsStorageP","text":"CredentialsStorage","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":" = SimpleKeychain())","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Auth0 Authentication API client."}],"type":"paragraph"}],"name":"authentication"},{"content":[{"inlineContent":[{"type":"text","text":"Key used to store user credentials in the Keychain. Defaults to ‘credentials’."}],"type":"paragraph"}],"name":"storeKey"},{"name":"storage","content":[{"inlineContent":[{"type":"text","text":"The "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true,"type":"reference"},{"type":"text","text":" instance used to manage credentials storage. Defaults to a standard "},{"code":"SimpleKeychain","type":"codeVoice"},{"type":"text","text":" instance."}],"type":"paragraph"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","type":"topic","abstract":[{"text":"Creates a new ","type":"text"},{"code":"CredentialsManager","type":"codeVoice"},{"text":" instance.","type":"text"}],"role":"symbol","title":"init(authentication:storeKey:storage:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"},"https://auth0.com/docs/api/authentication":{"type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"sections":[],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"CredentialsManager","type":"codeVoice"},{"type":"text","text":" instance."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"authentication"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier","text":"Authentication"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storeKey"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storage"},{"text":": ","kind":"text"},{"text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":")"}],"externalID":"s:5Auth018CredentialsManagerV14authentication8storeKey7storageAcA14Authentication_p_SSAA0B7Storage_ptcfc","roleHeading":"Initializer","symbolKind":"init","role":"symbol","title":"init(authentication:storeKey:storage:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth014AuthenticationP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","text":"Authentication","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storeKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" = \"credentials\", ","kind":"text"},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"text":" = SimpleKeychain())","kind":"text"}]}]},{"parameters":[{"name":"authentication","content":[{"type":"paragraph","inlineContent":[{"text":"Auth0 Authentication API client.","type":"text"}]}]},{"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":[{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true,"type":"reference"},{"text":" instance used to manage credentials storage. Defaults to a standard ","type":"text"},{"type":"codeVoice","code":"SimpleKeychain"},{"text":" instance.","type":"text"}]}]}],"kind":"parameters"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"authentication"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier","text":"Authentication"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storage"},{"text":": ","kind":"text"},{"text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":")"}],"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","title":"init(authentication:storeKey:storage:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"CredentialsManager","type":"codeVoice"},{"type":"text","text":" instance."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ 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 baab89ea..1e11ca6c 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 @@ -{"metadata":{"extendedModule":"Auth0","title":"renew(parameters:headers:)","symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headersAA0B0CSDySSypG_SDyS2SGtYaKF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","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"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use."}],"type":"paragraph"}],"name":"parameters"},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use."}]}]},{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"text":"Callback that receives a ","type":"text"},{"code":"Result","type":"codeVoice"},{"text":" containing either the renewed user’s credentials or an error.","type":"text"}]}]}]},{"content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"type":"codeListing","code":["do {"," let credentials = try await credentialsManager.renew()"," print(\"Renewed credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"If you need to specify custom parameters or headers:","type":"text"}]},{"code":["let credentials = try await credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"],"syntax":"swift","type":"codeListing"},{"type":"aside","name":"Requires","style":"note","content":[{"type":"paragraph","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"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true,"type":"reference"},{"type":"text","text":" error will be thrown."}]}]},{"style":"warning","name":"Warning","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"},{"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"},{"text":" ","type":"text"},{"type":"text","text":"cause concurrency issues."}]}]},{"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"},{"text":" ","type":"text"},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}]}],"style":"important"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m"],"traits":[{"interfaceLanguage":"swift"}]}],"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","schemaVersion":{"major":0,"minor":3,"patch":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"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"https://auth0.com/docs/api/authentication#refresh-token":{"type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"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"}]},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"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"},{"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"}],"role":"symbol","type":"topic","kind":"symbol","title":"renew(parameters:headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","type":"topic","title":"store(credentials:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"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."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","title":"noRefreshToken"},"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","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","interfaceLanguage":"swift"},"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":"."}],"metadata":{"extendedModule":"Auth0","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headersAA0B0CSDySSypG_SDyS2SGtYaKF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"renew(parameters:headers:)","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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":"], "},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}]},"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"}],"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use."}]}],"name":"parameters"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use.","type":"text"}]}],"name":"headers"},{"name":"callback","content":[{"inlineContent":[{"text":"Callback that receives a ","type":"text"},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the renewed user’s credentials or an error."}],"type":"paragraph"}]}]},{"content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"syntax":"swift","type":"codeListing","code":["do {"," let credentials = try await credentialsManager.renew()"," print(\"Renewed credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"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\"])"],"type":"codeListing","syntax":"swift"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"The scope ","type":"text"},{"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":" "},{"text":"there is no refresh token, a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference"},{"text":" error will be thrown.","type":"text"}]}],"name":"Requires","style":"note"},{"style":"warning","name":"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"},{"text":" ","type":"text"},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"reference"},{"text":" is not, calling it anyway can","type":"text"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}]}],"type":"aside"},{"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"},{"type":"text","text":" "},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}]}],"name":"Important","type":"aside"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"type":"text","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":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"topic","title":"store(credentials:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","role":"symbol","type":"topic","title":"renew(parameters:headers:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"text":"(","kind":"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"},{"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"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"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"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"identifier":"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"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"}}} \ 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 593ab170..d703c013 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 @@ -{"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20"},"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"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"] = [:], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"] = [:]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"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":", "},{"text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use."}],"type":"paragraph"}],"name":"parameters"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use.","type":"text"}]}],"name":"headers"}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"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":[{"text":"If you need to specify custom parameters or headers:","type":"text"}]},{"syntax":"swift","code":["credentialsManager"," .renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing"},{"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 subscription will complete with a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference"},{"type":"text","text":" "},{"type":"text","text":"error."}]}],"style":"note","type":"aside","name":"Requires"},{"style":"warning","name":"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","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"}]}],"type":"aside"},{"content":[{"type":"paragraph","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":"aside","style":"important","name":"Important"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"]}],"sections":[],"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":{"patch":0,"major":0,"minor":3},"metadata":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","extendedModule":"Auth0","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSDySSypG_SDyS2SGtF","roleHeading":"Instance Method","title":"renew(parameters:headers:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","title":"noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","type":"topic","title":"store(credentials:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"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"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"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"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","type":"topic","title":"renew(parameters:headers:)"},"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"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"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"https://auth0.com/docs/secure/tokens/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","title":"Refresh Tokens","type":"link"}}} \ No newline at end of file +{"kind":"symbol","metadata":{"externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSDySSypG_SDyS2SGtF","extendedModule":"Auth0","symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","title":"renew(parameters:headers:)"},"abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"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":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"] = [:]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"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"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional parameters to use.","type":"text"}]}],"name":"parameters"},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"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)"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"If you need to specify custom parameters or headers:","type":"text"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"name":"Requires","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","isActive":true,"type":"reference"},{"type":"text","text":" "},{"text":"error.","type":"text"}],"type":"paragraph"}],"type":"aside"},{"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"},{"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"},{"text":" is not, calling it anyway can","type":"text"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}]}],"style":"warning","type":"aside","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"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}]}],"name":"Important","type":"aside"}]}],"sections":[],"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"topic","title":"store(credentials:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"type":"text","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":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"https://auth0.com/docs/api/authentication#refresh-token":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","type":"topic","title":"renew(parameters:headers:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]}}} \ 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 6274a73c..3a73d826 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 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"callback"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"text":" (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Additional parameters to use.","type":"text"}],"type":"paragraph"}],"name":"parameters"},{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"text":" containing either the renewed user’s credentials or an error.","type":"text"}],"type":"paragraph"}],"name":"callback"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"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"},{"inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"]},{"name":"Requires","style":"note","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"},{"type":"text","text":" "},{"text":"there is no refresh token, the callback will be called with a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference"},{"type":"text","text":" error."}],"type":"paragraph"}],"type":"aside"},{"name":"Warning","style":"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"},{"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"},{"type":"text","text":" "},{"text":"cause concurrency issues.","type":"text"}]}],"type":"aside"},{"style":"important","name":"Important","type":"aside","content":[{"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"}],"type":"paragraph"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","interfaceLanguage":"swift"},"metadata":{"title":"renew(parameters:headers:callback:)","role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers8callbackySDySSypG_SDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"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"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":")"}]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)"]}],"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"]}],"abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","type":"topic","title":"store(credentials:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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","title":"Refresh Tokens","type":"link","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"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."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","title":"noRefreshToken"},"https://auth0.com/docs/api/authentication#refresh-token":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"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"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","type":"topic","title":"renew(parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"kind":"article","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"text":"(","kind":"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"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"] = [:], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"kind":"text","text":" ("},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"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":">) -> "},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use."}]}],"name":"parameters"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use."}]}],"name":"headers"},{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"text":"Callback that receives a ","type":"text"},{"code":"Result","type":"codeVoice"},{"text":" containing either the renewed user’s credentials or an error.","type":"text"}]}]}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"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":[{"text":"If you need to specify custom parameters or headers:","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"]},{"content":[{"type":"paragraph","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"},{"text":" ","type":"text"},{"text":"there is no refresh token, the callback will be called with a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error."}]}],"type":"aside","style":"note","name":"Requires"},{"name":"Warning","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":" "},{"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"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}],"type":"paragraph"}],"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."}]}],"type":"aside"}],"kind":"content"}],"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers8callbackySDySSypG_SDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","roleHeading":"Instance Method","title":"renew(parameters:headers:callback:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","interfaceLanguage":"swift"},"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"}],"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"type":"text","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":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"type":"topic","kind":"article","role":"article","title":"Refresh Tokens: Common Errors","abstract":[],"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"https://auth0.com/docs/api/authentication#refresh-token":{"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"}],"type":"link"},"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","title":"Refresh Tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"topic","title":"store(credentials:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}],"title":"renew(parameters:headers:callback:)","role":"symbol","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","title":"CredentialsManagerResult","type":"topic","url":"\/documentation\/auth0\/credentialsmanagerresult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"kind":"symbol"}}} \ 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 85045dc7..82c81a36 100644 --- a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-6wgai.json +++ b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-6wgai.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}]}]},{"parameters":[{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"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","type":"codeListing","code":["try await credentialsManager.revoke(headers: [\"key\": \"value\"])"]},{"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","name":"Throws","content":[{"inlineContent":[{"type":"text","text":"An error of type "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside"}],"kind":"content"}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV6revoke7headersySDyS2SG_tYaKF","roleHeading":"Instance Method","extendedModule":"Auth0","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"modules":[{"name":"Auth0"}],"title":"revoke(headers:)","symbolKind":"method"},"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"},{"type":"text","text":" "},{"text":"was successful. Otherwise, the credentials are not cleared and an error is thrown.","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","interfaceLanguage":"swift"},"references":{"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"},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"kind":"symbol","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"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and an error is thrown.","type":"text"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"title":"revoke(headers:)","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"roleHeading":"Instance Method","title":"revoke(headers:)","modules":[{"name":"Auth0"}],"symbolKind":"method","extendedModule":"Auth0","externalID":"s:5Auth018CredentialsManagerV6revoke7headersySDyS2SG_tYaKF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","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"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"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"},{"text":"] = [:]) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use when revoking the refresh token."}]}]}],"kind":"parameters"},{"content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["do {"," try await credentialsManager.revoke()"," print(\"Revoked refresh token and cleared credentials\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"inlineContent":[{"type":"text","text":"If you need to specify custom headers for the refresh token revocation:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["try await credentialsManager.revoke(headers: [\"key\": \"value\"])"]},{"inlineContent":[{"text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and no error is thrown.","type":"text"}],"type":"paragraph"},{"name":"Throws","style":"note","type":"aside","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":"."}]}]}],"kind":"content"}],"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."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","title":"revoke(headers:)","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 an error is thrown.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","role":"symbol","kind":"symbol"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"}}} \ 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 69b69cea..46c96a4c 100644 --- a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-9mzo6.json +++ b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-9mzo6.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"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"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"] = [:]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when revoking the refresh token."}],"type":"paragraph"}]}]},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A type-erased publisher.","type":"text"}]}],"kind":"content"},{"content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"type":"codeListing","syntax":"swift","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":[{"text":"If you need to specify custom headers for the refresh token revocation:","type":"text"}]},{"code":["credentialsManager"," .revoke(headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and the subscription","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"completes without an error."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"revoke(headers:)","modules":[{"name":"Auth0"}],"symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV6revoke7headers7Combine12AnyPublisherVyytAA0bC5ErrorVGSDyS2SG_tF","extendedModule":"Auth0","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"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"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","title":"Refresh Tokens"},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","abstract":[{"text":"Calls the ","type":"text"},{"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"},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error."}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","title":"revoke(headers:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:]) -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"inlineContent":[{"text":"A type-erased publisher.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"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)"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"If you need to specify custom headers for the refresh token revocation:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .revoke(headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"]},{"inlineContent":[{"text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and the subscription","type":"text"},{"type":"text","text":" "},{"text":"completes without an error.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6"]}],"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"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","extendedModule":"Auth0","roleHeading":"Instance Method","role":"symbol","title":"revoke(headers:)","externalID":"s:5Auth018CredentialsManagerV6revoke7headers7Combine12AnyPublisherVyytAA0bC5ErrorVGSDyS2SG_tF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":">"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"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/revoke(headers:)-9mzo6":{"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"title":"revoke(headers:)","role":"symbol","abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"type":"text","text":" "},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","kind":"symbol"}}} \ 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 ca72ed54..e3004b57 100644 --- a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:_:).json +++ b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:_:).json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"title":"revoke(headers:_:)","symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV6revoke7headers_ySDyS2SG_ys6ResultOyytAA0bC5ErrorVGctF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"], (","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"role":"symbol","roleHeading":"Instance Method"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)"},"schemaVersion":{"major":0,"minor":3,"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"},{"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 "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"reference","isActive":true},{"text":" error.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)"],"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"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"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"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"callback","kind":"internalParam"},{"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"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use when revoking the refresh token."}]}],"name":"headers"},{"name":"callback","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"}]}]},{"kind":"content","content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"type":"codeListing","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":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom headers for the refresh token revocation:"}]},{"syntax":"swift","code":["credentialsManager.revoke(headers: [\"key\": \"value\"]) { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and the callback is"},{"type":"text","text":" "},{"text":"invoked with a success case.","type":"text"}],"type":"paragraph"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"title":"revokeFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","abstract":[{"type":"text","text":"The revocation of the refresh token 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"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"title":"Authentication API Endpoint","type":"link","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"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"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"},{"type":"text","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"},{"text":"result containing a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","isActive":true,"type":"reference"},{"type":"text","text":" error."}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"], (","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","title":"revoke(headers:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult"}}} \ No newline at end of file +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"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"},{"type":"text","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 "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed"},{"type":"text","text":" error."}],"metadata":{"role":"symbol","title":"revoke(headers:_:)","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"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"], (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV6revoke7headers_ySDyS2SG_ys6ResultOyytAA0bC5ErrorVGctF","symbolKind":"method"},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"callback"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","kind":"typeIdentifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use when revoking the refresh token."}]}],"name":"headers"},{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"text":" containing either an empty success case or an error.","type":"text"}]}]}]},{"content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"type":"codeListing","code":["credentialsManager.revoke { result in"," switch result {"," case .success:"," print(\"Revoked refresh token and cleared credentials\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"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"},{"text":" ","type":"text"},{"type":"text","text":"invoked with a success case."}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"revokeFailed","abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"type":"reference","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","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"], ("},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","title":"revoke(headers:_:)","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 will not be cleared and the callback will be called with a failure"},{"type":"text","text":" "},{"type":"text","text":"result containing a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed"},{"text":" error.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","title":"CredentialsManagerResult","type":"topic","url":"\/documentation\/auth0\/credentialsmanagerresult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"kind":"symbol"}}} \ 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 de9b5614..dfbdbd1b 100644 --- a/docs/data/documentation/auth0/credentialsmanager/store(credentials:).json +++ b/docs/data/documentation/auth0/credentialsmanager/store(credentials:).json @@ -1 +1 @@ -{"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/store(credentials:)"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"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"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"credentials","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Credentials instance to store."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"If the credentials were stored.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"code":["let didStore = credentialsManager.store(credentials: credentials)"],"type":"codeListing","syntax":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","title":"store(credentials:)","roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV5store11credentialsSbAA0B0C_tF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","type":"topic","title":"store(credentials:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/store(credentials:)"]}],"abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}]},{"parameters":[{"name":"credentials","content":[{"inlineContent":[{"text":"Credentials instance to store.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the credentials were stored."}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"code":["let didStore = credentialsManager.store(credentials: credentials)"],"type":"codeListing","syntax":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"store(credentials:)","externalID":"s:5Auth018CredentialsManagerV5store11credentialsSbAA0B0C_tF"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"topic","title":"store(credentials:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]}}} \ 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 44c88ae6..5d78ae25 100644 --- a/docs/data/documentation/auth0/credentialsmanager/user.json +++ b/docs/data/documentation/auth0/credentialsmanager/user.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"user"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"syntax":"swift","code":["let user = credentialsManager.user"],"type":"codeListing"},{"name":"Important","type":"aside","style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Access to this property will not be protected by biometric authentication."}]}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/user"]}],"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","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"type":"text","text":"."}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV4userAA8UserInfoVSgvp","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":"?","kind":"text"}],"symbolKind":"property","title":"user","roleHeading":"Instance Property","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"url":"\/documentation\/auth0\/credentialsmanager\/user","identifier":"doc:\/\/com.auth0.Auth0\/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"},{"text":"The user information is read from the stored ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"text":".","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":"?","kind":"text"}],"kind":"symbol","type":"topic","role":"symbol","title":"user"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"kind":"symbol","type":"topic","role":"symbol","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"user"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","code":["let user = credentialsManager.user"],"syntax":"swift"},{"type":"aside","style":"important","content":[{"inlineContent":[{"type":"text","text":"Access to this property will not be protected by biometric authentication."}],"type":"paragraph"}],"name":"Important"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"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 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},{"text":".","type":"text"}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"},"metadata":{"role":"symbol","title":"user","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"user","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth018CredentialsManagerV4userAA8UserInfoVSgvp","symbolKind":"property"},"references":{"https://auth0.com/docs/secure/tokens/id-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","title":"ID token","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"type":"text","text":"ID token"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager","kind":"symbol","title":"CredentialsManager","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","role":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/user","kind":"symbol","title":"user","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"text":": ","kind":"text"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired."},{"text":" ","type":"text"},{"text":"The user information is read from the stored ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"type":"text","text":"."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror.json b/docs/data/documentation/auth0/credentialsmanagererror.json index c24fc2ab..016aaf87 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror.json +++ b/docs/data/documentation/auth0/credentialsmanagererror.json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Structure","title":"CredentialsManagerError","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"symbolKind":"struct","modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"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"],"kind":"relationships","title":"Conforms To"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"]},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription"]},{"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"},{"title":"Default Implementations","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}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"references":{"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","role":"symbol","abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"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":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"~=(_:_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"largeMinTTL","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","url":"\/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"},{"type":"text","text":" "},{"type":"text","text":"increase the "},{"type":"strong","inlineContent":[{"text":"Token Expiration","type":"text"}]},{"type":"text","text":" value in the settings page of your "},{"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","isActive":true,"type":"reference"},{"text":".","type":"text"},{"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":"."}],"kind":"symbol","title":"largeMinTTL","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","type":"topic","title":"debugDescription"},"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."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","title":"noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"abstract":[{"text":"The biometric authentication failed.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"LAError"},{"type":"text","text":" can be accessed via the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","type":"topic","title":"biometricsFailed"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"No credentials were found in the store."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","type":"topic","title":"noCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"renewFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"The credentials renewal failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true},{"type":"text","text":" can be accessed via the "},{"type":"reference","isActive":true,"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","type":"topic","title":"renewFailed"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","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."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","type":"topic","title":"~=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"role":"collectionGroup","kind":"article","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","type":"topic","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","title":"storeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","abstract":[{"type":"text","text":"Storing the renewed credentials failed."},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"abstract":[],"type":"topic","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","title":"LocalizedError Implementations"},"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":"."}],"type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","kind":"symbol","role":"symbol","title":"cause","url":"\/documentation\/auth0\/credentialsmanagererror\/cause"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"title":"revokeFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","abstract":[{"type":"text","text":"The revocation of the refresh token 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"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"https://manage.auth0.com/#/apis/":{"title":"Auth0 API","identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 API"}],"url":"https:\/\/manage.auth0.com\/#\/apis\/"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"role":"collectionGroup","kind":"article","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","type":"topic","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"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"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"sections":[],"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"}],"metadata":{"symbolKind":"struct","title":"CredentialsManagerError","externalID":"s:5Auth023CredentialsManagerErrorV","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"roleHeading":"Structure","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","kind":"article","type":"topic","title":"Equatable Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"revokeFailed","abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"type":"reference","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","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","title":"biometricsFailed","abstract":[{"type":"text","text":"The biometric authentication failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"LAError"},{"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"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","kind":"article","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","abstract":[],"role":"collectionGroup","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","title":"largeMinTTL","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"},{"code":"minTTL","type":"codeVoice"},{"type":"text","text":" or"},{"type":"text","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,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/apis\/"},{"type":"text","text":"."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"largeMinTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","title":"debugDescription","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"url":"\/documentation\/auth0\/credentialsmanagererror\/cause","kind":"symbol","title":"cause","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"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"},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","title":"~=(_:_:)","abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" values in a switch statement.","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"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"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"kind":"symbol","title":"storeFailed","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","abstract":[{"type":"text","text":"Storing the renewed credentials failed."},{"type":"text","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":"."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","role":"symbol","abstract":[{"text":"Matches ","type":"text"},{"code":"CredentialsManagerError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}]},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"abstract":[{"text":"No credentials were found in the store.","type":"text"},{"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},{"text":".","type":"text"}],"type":"topic","title":"noCredentials","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renewFailed"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"title":"renewFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","role":"symbol","abstract":[{"text":"The credentials renewal failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true},{"type":"text","text":" can be accessed via the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":" property."}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"https://manage.auth0.com/#/apis/":{"url":"https:\/\/manage.auth0.com\/#\/apis\/","titleInlineContent":[{"text":"Auth0 API","type":"text"}],"title":"Auth0 API","type":"link","identifier":"https:\/\/manage.auth0.com\/#\/apis\/"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"type":"text","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":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic"},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"role":"collectionGroup","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","kind":"article"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json b/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json index 568b4fd6..89ba8566 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json +++ b/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","roleHeading":"Operator","extendedModule":"Swift","symbolKind":"op","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","modules":[{"relatedModules":["Swift"],"name":"Auth0"}]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"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"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"role":"collectionGroup","kind":"article","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","type":"topic","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"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"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","type":"topic","abstract":[],"kind":"symbol","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"role":"symbol","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","extendedModule":"Swift","title":"!=(_:_:)","symbolKind":"op"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"role":"symbol","kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"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":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","title":"!=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","kind":"article","type":"topic","title":"Equatable Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json b/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json index eb316147..521489d1 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json +++ b/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)"},"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"metadata":{"role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV2eeoiySbAC_ACtFZ","roleHeading":"Operator","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"symbolKind":"op","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"==(_:_:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"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"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"title":"==(_:_:)","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"role":"collectionGroup","kind":"article","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","type":"topic","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"]]},"abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)"]}],"metadata":{"title":"==(_:_:)","role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV2eeoiySbAC_ACtFZ","symbolKind":"op","roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"extendedModule":"Auth0","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","kind":"article","type":"topic","title":"Equatable Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"title":"==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","type":"topic","role":"symbol","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","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","kind":"symbol"}}} \ 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 49b83ae7..16ad676b 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/auth0error-implementations.json @@ -1 +1 @@ -{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"],"generated":true,"title":"Instance Properties"}],"kind":"article","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"},"metadata":{"title":"Auth0Error Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"type":"topic","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","title":"errorDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Description of the error."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"type":"topic","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","title":"localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Description of the error."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Auth0Error Implementations","role":"collectionGroup"},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"],"generated":true}],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations"]}],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Description of the error."}],"title":"errorDescription","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}}} \ 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 c79b90b5..292799bc 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/biometricsfailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/biometricsfailed.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed"},"abstract":[{"text":"The biometric authentication failed.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"LAError"},{"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"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"biometricsFailed","kind":"identifier"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","metadata":{"symbolKind":"property","externalID":"s:5Auth023CredentialsManagerErrorV16biometricsFailedACvpZ","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"biometricsFailed","kind":"identifier"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"biometricsFailed"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"abstract":[{"text":"The biometric authentication failed.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"LAError"},{"type":"text","text":" can be accessed via the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","type":"topic","title":"biometricsFailed"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"biometricsFailed","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV16biometricsFailedACvpZ","role":"symbol","roleHeading":"Type Property","symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"biometricsFailed"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"title":"biometricsFailed"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","title":"biometricsFailed","abstract":[{"type":"text","text":"The biometric authentication failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"LAError"},{"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"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}}} \ 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 fd65fa59..9cdaaf30 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/cause.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/cause.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/cause"]}],"metadata":{"symbolKind":"property","externalID":"s:5Auth023CredentialsManagerErrorV5causes0D0_pSgvp","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"cause"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause"},"references":{"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":"."}],"type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","kind":"symbol","role":"symbol","title":"cause","url":"\/documentation\/auth0\/credentialsmanagererror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/cause"]}],"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"metadata":{"title":"cause","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV5causes0D0_pSgvp","roleHeading":"Instance Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"url":"\/documentation\/auth0\/credentialsmanagererror\/cause","kind":"symbol","title":"cause","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"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"},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 9223fbd8..48559597 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/debugdescription.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/debugdescription.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/debugdescription"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"style":"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."}]}],"name":"Important","type":"aside"}]}],"abstract":[{"type":"text","text":"Description of the error."}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV16debugDescriptionSSvp","title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"symbolKind":"property","roleHeading":"Instance Property","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","type":"topic","title":"debugDescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV16debugDescriptionSSvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","title":"debugDescription"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"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"},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"type":"text","text":" only."}]}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","title":"debugDescription","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 62a7ac7a..436e4e0c 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/equatable-implementations.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/equatable-implementations.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations"]}],"sections":[],"kind":"article","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","interfaceLanguage":"swift"},"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"title":"Equatable Implementations","roleHeading":"API Collection"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"title":"Operators","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"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"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","type":"topic","abstract":[],"kind":"symbol","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"title":"==(_:_:)","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"article","topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)"],"generated":true,"title":"Operators"}],"sections":[],"metadata":{"role":"collectionGroup","title":"Equatable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"role":"symbol","kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"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":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","title":"!=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"title":"==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","type":"topic","role":"symbol","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","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","kind":"symbol"}}} \ 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 ce36c1e9..09733382 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/errordescription.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/errordescription.json @@ -1 +1 @@ -{"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","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"aside","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"}]}],"style":"important"}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"roleHeading":"Instance Property","extendedModule":"Auth0","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","title":"errorDescription","symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"abstract":[{"type":"text","text":"Description of the error."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"type":"topic","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","title":"errorDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Description of the error."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"role":"collectionGroup","kind":"article","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","type":"topic","title":"Auth0Error Implementations"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription"},"schemaVersion":{"major":0,"patch":0,"minor":3},"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":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"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."}]}],"name":"Important","type":"aside","style":"important"}],"kind":"content"}],"metadata":{"title":"errorDescription","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","extendedModule":"Auth0","symbolKind":"property","modules":[{"name":"Auth0"}],"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"}],"roleHeading":"Instance Property","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"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","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","kind":"article","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","abstract":[],"role":"collectionGroup","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Description of the error."}],"title":"errorDescription","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription"}}} \ 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 8852dac0..0cfdda0a 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/failurereason.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/failurereason.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":[{"introducedAt":"8.0","name":"iOS","deprecated":false,"unavailable":false,"beta":false},{"beta":false,"introducedAt":"10.10","name":"macOS","unavailable":false,"deprecated":false},{"deprecated":false,"beta":false,"unavailable":false,"name":"tvOS","introducedAt":"9.0"},{"name":"watchOS","beta":false,"deprecated":false,"introducedAt":"2.0","unavailable":false}],"title":"failureReason","symbolKind":"property","extendedModule":"Foundation","role":"symbol","roleHeading":"Instance Property"},"kind":"symbol","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":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/failurereason"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"abstract":[],"type":"topic","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","title":"failureReason","abstract":[],"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"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"failureReason","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"platforms":[{"deprecated":false,"unavailable":false,"name":"iOS","introducedAt":"8.0","beta":false},{"name":"macOS","introducedAt":"10.10","deprecated":false,"unavailable":false,"beta":false},{"unavailable":false,"beta":false,"deprecated":false,"name":"tvOS","introducedAt":"9.0"},{"name":"watchOS","deprecated":false,"unavailable":false,"beta":false,"introducedAt":"2.0"}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","extendedModule":"Foundation"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/failurereason"]}],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"type":"text","text":"."}],"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":[],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"role":"collectionGroup","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"title":"failureReason","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","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"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}}} \ 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 fd4ddbf5..6d83bacf 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/helpanchor.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/helpanchor.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"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":" }"}]}],"kind":"declarations"}],"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":{"extendedModule":"Foundation","title":"helpAnchor","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":[{"introducedAt":"8.0","deprecated":false,"unavailable":false,"name":"iOS","beta":false},{"deprecated":false,"unavailable":false,"name":"macOS","introducedAt":"10.10","beta":false},{"introducedAt":"9.0","unavailable":false,"deprecated":false,"beta":false,"name":"tvOS"},{"unavailable":false,"beta":false,"name":"watchOS","introducedAt":"2.0","deprecated":false}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","symbolKind":"property"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"type":"text","text":"."}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","title":"helpAnchor","abstract":[],"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"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"abstract":[],"type":"topic","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","title":"LocalizedError Implementations"}}} \ No newline at end of file +{"metadata":{"role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"extendedModule":"Foundation","title":"helpAnchor","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","symbolKind":"property","platforms":[{"name":"iOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"8.0"},{"beta":false,"name":"macOS","unavailable":false,"introducedAt":"10.10","deprecated":false},{"beta":false,"name":"tvOS","introducedAt":"9.0","deprecated":false,"unavailable":false},{"unavailable":false,"beta":false,"deprecated":false,"name":"watchOS","introducedAt":"2.0"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"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":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"role":"collectionGroup","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"title":"helpAnchor","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"kind":"symbol","type":"topic"}}} \ 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 2bf78ac2..0f9d1e2c 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/largeminttl.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/largeminttl.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"largeMinTTL","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"languages":["swift"]}]}],"metadata":{"title":"largeMinTTL","symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"largeMinTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"externalID":"s:5Auth023CredentialsManagerErrorV11largeMinTTLACvpZ","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/largeminttl"],"traits":[{"interfaceLanguage":"swift"}]}],"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"},{"type":"text","text":" "},{"text":"increase the ","type":"text"},{"inlineContent":[{"type":"text","text":"Token Expiration"}],"type":"strong"},{"type":"text","text":" value in the settings page of your "},{"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","isActive":true,"type":"reference"},{"text":".","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":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"largeMinTTL","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","url":"\/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"},{"type":"text","text":" "},{"type":"text","text":"increase the "},{"type":"strong","inlineContent":[{"text":"Token Expiration","type":"text"}]},{"type":"text","text":" value in the settings page of your "},{"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","isActive":true,"type":"reference"},{"text":".","type":"text"},{"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":"."}],"kind":"symbol","title":"largeMinTTL","role":"symbol","type":"topic"},"https://manage.auth0.com/#/apis/":{"type":"link","title":"Auth0 API","identifier":"https:\/\/manage.auth0.com\/#\/apis\/","titleInlineContent":[{"type":"text","text":"Auth0 API"}],"url":"https:\/\/manage.auth0.com\/#\/apis\/"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"largeMinTTL","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}]}]}],"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"},{"text":" or","type":"text"},{"type":"text","text":" "},{"type":"text","text":"increase the "},{"type":"strong","inlineContent":[{"type":"text","text":"Token Expiration"}]},{"type":"text","text":" value in the settings page of your "},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/apis\/","isActive":true},{"type":"text","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":"."}],"metadata":{"symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"largeMinTTL","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"modules":[{"name":"Auth0"}],"title":"largeMinTTL","externalID":"s:5Auth023CredentialsManagerErrorV11largeMinTTLACvpZ","roleHeading":"Type Property","role":"symbol"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/largeminttl"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"https://manage.auth0.com/#/apis/":{"titleInlineContent":[{"text":"Auth0 API","type":"text"}],"url":"https:\/\/manage.auth0.com\/#\/apis\/","type":"link","title":"Auth0 API","identifier":"https:\/\/manage.auth0.com\/#\/apis\/"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","title":"largeMinTTL","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"},{"code":"minTTL","type":"codeVoice"},{"type":"text","text":" or"},{"type":"text","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,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/apis\/"},{"type":"text","text":"."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"largeMinTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 bade58e6..09f38d2f 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/localizeddescription.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/localizeddescription.json @@ -1 +1 @@ -{"metadata":{"extendedModule":"Auth0","symbolKind":"property","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"localizedDescription"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizeddescription"]}],"abstract":[{"type":"text","text":"Description of the error."}],"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"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"name":"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":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}],"type":"paragraph"}],"style":"important"}]}],"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"role":"collectionGroup","kind":"article","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","type":"topic","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"type":"topic","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","title":"localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Description of the error."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"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"}]},{"type":"text","text":" only."}],"type":"paragraph"}],"style":"important","type":"aside"}]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","roleHeading":"Instance Property","title":"localizedDescription","symbolKind":"property","extendedModule":"Auth0","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"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","schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Description of the error.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","kind":"article","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","abstract":[],"role":"collectionGroup","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}}} \ 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 398b65b6..c2f36ee3 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/localizederror-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"LocalizedError Implementations","roleHeading":"API Collection","role":"collectionGroup"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"kind":"article","topicSections":[{"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"],"generated":true}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","title":"failureReason","abstract":[],"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"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","title":"helpAnchor","abstract":[],"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"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","title":"recoverySuggestion","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","kind":"symbol","role":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"article","metadata":{"role":"collectionGroup","title":"LocalizedError Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"topicSections":[{"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"],"generated":true}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"title":"failureReason","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","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"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"title":"helpAnchor","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"title":"recoverySuggestion","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","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"}],"kind":"symbol","type":"topic"}}} \ 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 06b3844b..367726f7 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/nocredentials.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/nocredentials.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noCredentials","kind":"identifier"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"No credentials were found in the store.","type":"text"},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/nocredentials"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Type Property","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","title":"noCredentials","externalID":"s:5Auth023CredentialsManagerErrorV02noB0ACvpZ","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"No credentials were found in the store."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","type":"topic","title":"noCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials"},"sections":[],"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","type":"reference","isActive":true},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/nocredentials"]}],"metadata":{"roleHeading":"Type Property","externalID":"s:5Auth023CredentialsManagerErrorV02noB0ACvpZ","title":"noCredentials","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noCredentials","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"abstract":[{"text":"No credentials were found in the store.","type":"text"},{"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},{"text":".","type":"text"}],"type":"topic","title":"noCredentials","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}}} \ 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 6d6fd060..e5ee8839 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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"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},{"type":"text","text":"."}],"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth023CredentialsManagerErrorV14noRefreshTokenACvpZ","roleHeading":"Type Property","role":"symbol","title":"noRefreshToken"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","title":"noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"modules":[{"name":"Auth0"}],"title":"noRefreshToken","roleHeading":"Type Property","role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV14noRefreshTokenACvpZ","symbolKind":"property"},"abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"text":" instance does not contain a refresh token.","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},{"text":".","type":"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":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"type":"text","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":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic"}}} \ 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 34f56d3b..ae6d6d98 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/recoverysuggestion.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","interfaceLanguage":"swift"},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"text":".","type":"text"}],"metadata":{"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"extendedModule":"Foundation","symbolKind":"property","role":"symbol","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","platforms":[{"introducedAt":"8.0","unavailable":false,"name":"iOS","beta":false,"deprecated":false},{"deprecated":false,"name":"macOS","introducedAt":"10.10","beta":false,"unavailable":false},{"introducedAt":"9.0","beta":false,"deprecated":false,"unavailable":false,"name":"tvOS"},{"beta":false,"name":"watchOS","introducedAt":"2.0","deprecated":false,"unavailable":false}],"title":"recoverySuggestion"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"abstract":[],"type":"topic","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","title":"recoverySuggestion","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"metadata":{"platforms":[{"unavailable":false,"deprecated":false,"beta":false,"name":"iOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"introducedAt":"10.10","name":"macOS","beta":false},{"beta":false,"deprecated":false,"introducedAt":"9.0","name":"tvOS","unavailable":false},{"unavailable":false,"introducedAt":"2.0","name":"watchOS","deprecated":false,"beta":false}],"symbolKind":"property","role":"symbol","title":"recoverySuggestion","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"extendedModule":"Foundation","roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}]},"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":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"type":"text","text":"."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","interfaceLanguage":"swift"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"title":"recoverySuggestion","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","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"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"role":"collectionGroup","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","kind":"article"}}} \ 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 9c2b45c8..fe50c98e 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/renewfailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/renewfailed.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renewFailed"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"roleHeading":"Type Property","role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV11renewFailedACvpZ","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"renewFailed"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"renewFailed","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}]}]}],"abstract":[{"text":"The credentials renewal failed.","type":"text"},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":" 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":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/renewfailed"]}],"kind":"symbol","sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"renewFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"The credentials renewal failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true},{"type":"text","text":" can be accessed via the "},{"type":"reference","isActive":true,"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","type":"topic","title":"renewFailed"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"renewFailed","kind":"identifier"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/renewfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"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"},{"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"}],"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV11renewFailedACvpZ","modules":[{"name":"Auth0"}],"title":"renewFailed","symbolKind":"property","roleHeading":"Type Property","role":"symbol","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"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renewFailed"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"title":"renewFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","role":"symbol","abstract":[{"text":"The credentials renewal failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true},{"type":"text","text":" can be accessed via the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":" property."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}}} \ 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 91111927..2dc688f6 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/revokefailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/revokefailed.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/revokefailed"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","text":"CredentialsManagerError"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","interfaceLanguage":"swift"},"metadata":{"title":"revokeFailed","symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"revokeFailed","kind":"identifier"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"externalID":"s:5Auth023CredentialsManagerErrorV12revokeFailedACvpZ","roleHeading":"Type Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"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},{"type":"text","text":" property."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"title":"revokeFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","abstract":[{"type":"text","text":"The revocation of the refresh token 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"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/revokefailed"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The revocation of the refresh token failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference","isActive":true},{"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."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed"},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revokeFailed"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"externalID":"s:5Auth023CredentialsManagerErrorV12revokeFailedACvpZ","roleHeading":"Type Property","role":"symbol","title":"revokeFailed"},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"revokeFailed","abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"type":"reference","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","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"}}} \ 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 294e033a..8a8379fd 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/storefailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/storefailed.json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV11storeFailedACvpZ","title":"storeFailed","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"storeFailed"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"symbolKind":"property","role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/storefailed"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Storing the renewed credentials failed."},{"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"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","title":"storeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","abstract":[{"type":"text","text":"Storing the renewed credentials failed."},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"abstract":[{"text":"Storing the renewed credentials failed.","type":"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"},{"type":"text","text":"."}],"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"roleHeading":"Type Property","symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV11storeFailedACvpZ","title":"storeFailed","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"storeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/storefailed"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"kind":"symbol","title":"storeFailed","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","abstract":[{"type":"text","text":"Storing the renewed credentials failed."},{"type":"text","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":"."}],"type":"topic"}}} \ 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 51841986..b052da65 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-7k0od.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-7k0od.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"CredentialsManagerError"},{"type":"text","text":" values in a switch statement."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_ACtFZ","symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"extendedModule":"Auth0","role":"symbol","roleHeading":"Operator","modules":[{"name":"Auth0"}],"title":"~=(_:_:)"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","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."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","type":"topic","title":"~=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"symbolKind":"op","externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_ACtFZ","title":"~=(_:_:)","modules":[{"name":"Auth0"}],"roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","extendedModule":"Auth0"},"sections":[],"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"CredentialsManagerError"},{"text":" values in a switch statement.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od"]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","role":"symbol","abstract":[{"text":"Matches ","type":"text"},{"code":"CredentialsManagerError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}}} \ 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 5b48ef10..eabe2a63 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-93ixe.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-93ixe.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","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","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_s0D0_ptFZ","symbolKind":"op","title":"~=(_:_:)","roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","extendedModule":"Auth0"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","role":"symbol","abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"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":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"~=(_:_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe"]}],"sections":[],"metadata":{"role":"symbol","title":"~=(_:_:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_s0D0_ptFZ","symbolKind":"op","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"extendedModule":"Auth0","roleHeading":"Operator"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"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\/~=(_:_:)-93ixe"},"kind":"symbol","abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","title":"~=(_:_:)","abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" values in a switch statement.","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"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"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagerresult.json b/docs/data/documentation/auth0/credentialsmanagerresult.json index ded52d66..6967b8b9 100644 --- a/docs/data/documentation/auth0/credentialsmanagerresult.json +++ b/docs/data/documentation/auth0/credentialsmanagerresult.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"metadata":{"externalID":"s:5Auth024CredentialsManagerResulta","roleHeading":"Type Alias","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManagerResult"}],"modules":[{"name":"Auth0"}],"title":"CredentialsManagerResult","symbolKind":"typealias"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","interfaceLanguage":"swift"},"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = "},{"preciseIdentifier":"s:s6ResultO","text":"Result","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta1Txmfp"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagerresult"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"kind":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentialsmanagerresult"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"text":"T","kind":"genericParameter"},{"kind":"text","text":"> = "},{"kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO","text":"Result"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth024CredentialsManagerResulta1Txmfp"},{"kind":"text","text":", "},{"text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"metadata":{"role":"symbol","title":"CredentialsManagerResult","symbolKind":"typealias","modules":[{"name":"Auth0"}],"externalID":"s:5Auth024CredentialsManagerResulta","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"roleHeading":"Type Alias"},"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","title":"CredentialsManagerResult","type":"topic","url":"\/documentation\/auth0\/credentialsmanagerresult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"kind":"symbol","role":"symbol","title":"CredentialsManagerError","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsstorage.json b/docs/data/documentation/auth0/credentialsstorage.json index 58948e67..78bf8ad4 100644 --- a/docs/data/documentation/auth0/credentialsstorage.json +++ b/docs/data/documentation/auth0/credentialsstorage.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"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"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage"]}],"relationshipsSections":[{"kind":"relationships","type":"conformingTypes","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"],"title":"Conforming Types"}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}]}]}],"kind":"symbol","metadata":{"externalID":"s:5Auth018CredentialsStorageP","roleHeading":"Protocol","title":"CredentialsStorage","symbolKind":"protocol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"CredentialsStorage","kind":"identifier"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","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","kind":"symbol","role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"deleteEntry(forKey:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","required":true,"url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","type":"topic","abstract":[{"text":"Deletes a storage entry.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"title":"getEntry(forKey:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","required":true,"url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","type":"topic","abstract":[{"text":"Retrieves a storage entry.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"required":true,"title":"setEntry(_:forKey:)","abstract":[{"type":"text","text":"Sets a storage entry."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"setEntry"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"}}} \ No newline at end of file +{"metadata":{"symbolKind":"protocol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","roleHeading":"Protocol","externalID":"s:5Auth018CredentialsStorageP","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage"},"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:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","interfaceLanguage":"swift"},"relationshipsSections":[{"title":"Conforming Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"],"kind":"relationships","type":"conformingTypes"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"CredentialsStorage","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsstorage"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"text":"Conformance to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","required":true,"abstract":[{"type":"text","text":"Deletes a storage entry."}],"title":"deleteEntry(forKey:)","url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"title":"getEntry(forKey:)","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getEntry"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","required":true,"abstract":[{"type":"text","text":"Sets a storage entry."}],"title":"setEntry(_:forKey:)","url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"type":"topic"}}} \ 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 4fb707d5..2a96c034 100644 --- a/docs/data/documentation/auth0/credentialsstorage/deleteentry(forkey:).json +++ b/docs/data/documentation/auth0/credentialsstorage/deleteentry(forkey:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"The key to delete from the store.","type":"text"}],"type":"paragraph"}],"name":"key"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"If the entry was deleted.","type":"text"}]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"metadata":{"title":"deleteEntry(forKey:)","modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","externalID":"s:5Auth018CredentialsStorageP11deleteEntry6forKeySbSS_tF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"roleHeading":"Instance Method","required":true},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Deletes a storage entry."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"deleteEntry(forKey:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","required":true,"url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","type":"topic","abstract":[{"text":"Deletes a storage entry.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"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"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)"},"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsStorageP11deleteEntry6forKeySbSS_tF","title":"deleteEntry(forKey:)","required":true,"role":"symbol","symbolKind":"method","roleHeading":"Instance Method"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to delete from the store."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"If the entry was deleted.","type":"text"}]}]}],"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Deletes a storage entry."}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","required":true,"abstract":[{"type":"text","text":"Deletes a storage entry."}],"title":"deleteEntry(forKey:)","url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"}}} \ 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 bef8b0ab..56d197ae 100644 --- a/docs/data/documentation/auth0/credentialsstorage/getentry(forkey:).json +++ b/docs/data/documentation/auth0/credentialsstorage/getentry(forkey:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)"]}],"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"Retrieves a storage entry."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The key to get from the store.","type":"text"}]}],"name":"key"}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"The stored data."}],"type":"paragraph"}],"kind":"content"}],"metadata":{"title":"getEntry(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","required":true,"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth018CredentialsStorageP8getEntry6forKey10Foundation4DataVSgSS_tF","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"title":"getEntry(forKey:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","required":true,"url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","type":"topic","abstract":[{"text":"Retrieves a storage entry.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Retrieves a storage entry."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"metadata":{"title":"getEntry(forKey:)","required":true,"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsStorageP8getEntry6forKey10Foundation4DataVSgSS_tF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"key","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"text":"The key to get from the store.","type":"text"}]}]}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The stored data."}]}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"title":"getEntry(forKey:)","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getEntry"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 4c1e009e..63732c16 100644 --- a/docs/data/documentation/auth0/credentialsstorage/setentry(_:forkey:).json +++ b/docs/data/documentation/auth0/credentialsstorage/setentry(_:forkey:).json @@ -1 +1 @@ -{"metadata":{"symbolKind":"method","title":"setEntry(_:forKey:)","roleHeading":"Instance Method","required":true,"role":"symbol","externalID":"s:5Auth018CredentialsStorageP8setEntry_6forKeySb10Foundation4DataV_SStF","fragments":[{"text":"func","kind":"keyword"},{"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"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"data","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The data to be stored.","type":"text"}]}],"name":"data"},{"name":"key","content":[{"inlineContent":[{"text":"The key to store it to.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"text":"If the data was stored.","type":"text"}],"type":"paragraph"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)"]}],"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Sets a storage entry."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"required":true,"title":"setEntry(_:forKey:)","abstract":[{"type":"text","text":"Sets a storage entry."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"setEntry"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Sets a storage entry."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"metadata":{"externalID":"s:5Auth018CredentialsStorageP8setEntry_6forKeySb10Foundation4DataV_SStF","modules":[{"name":"Auth0"}],"required":true,"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"setEntry"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"setEntry(_:forKey:)","role":"symbol","roleHeading":"Instance Method"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"data","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}]},{"kind":"parameters","parameters":[{"name":"data","content":[{"inlineContent":[{"type":"text","text":"The data to be stored."}],"type":"paragraph"}]},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"text":"The key to store it to.","type":"text"}]}]}]},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"inlineContent":[{"text":"If the data was stored.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","required":true,"abstract":[{"type":"text","text":"Sets a storage entry."}],"title":"setEntry(_:forKey:)","url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/databaseuser.json b/docs/data/documentation/auth0/databaseuser.json index ef6208e1..9069a5fb 100644 --- a/docs/data/documentation/auth0/databaseuser.json +++ b/docs/data/documentation/auth0/databaseuser.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/databaseuser"]}],"sections":[],"kind":"symbol","abstract":[{"text":"A newly created database user (just the email, username, and email verified flag).","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"DatabaseUser"},{"text":" = (email","kind":"text"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", username","kind":"text"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, verified","kind":"text"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}]}]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"DatabaseUser"}],"roleHeading":"Type Alias","externalID":"s:5Auth012DatabaseUsera","symbolKind":"typealias","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"title":"DatabaseUser"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"kind":"symbol","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","role":"symbol","title":"DatabaseUser","url":"\/documentation\/auth0\/databaseuser","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"DatabaseUser","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"DatabaseUser"},{"kind":"text","text":" = (email"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", username"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, verified","kind":"text"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"role":"symbol","symbolKind":"typealias","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"externalID":"s:5Auth012DatabaseUsera","modules":[{"name":"Auth0"}],"title":"DatabaseUser","roleHeading":"Type Alias","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/databaseuser"]}],"abstract":[{"text":"A newly created database user (just the email, username, and email verified flag).","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"role":"symbol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/defaultscope.json b/docs/data/documentation/auth0/defaultscope.json index 1fdcd26c..a69244d3 100644 --- a/docs/data/documentation/auth0/defaultscope.json +++ b/docs/data/documentation/auth0/defaultscope.json @@ -1 +1 @@ -{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/defaultscope"]}],"abstract":[{"type":"text","text":"Default scope value used across Auth0.swift. Equals to "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"defaultScope","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"modules":[{"name":"Auth0"}],"roleHeading":"Global Variable","title":"defaultScope","externalID":"s:5Auth012defaultScopeSSvp","role":"symbol","symbolKind":"var"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"defaultScope","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"]}]}],"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\/defaultScope"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"kind":"symbol","type":"topic","abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","role":"symbol","title":"defaultScope","url":"\/documentation\/auth0\/defaultscope","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"roleHeading":"Global Variable","symbolKind":"var","externalID":"s:5Auth012defaultScopeSSvp","title":"defaultScope","modules":[{"name":"Auth0"}],"role":"symbol"},"abstract":[{"type":"text","text":"Default scope value used across Auth0.swift. Equals to "},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}],"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/defaultscope"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"defaultScope","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"defaultScope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","kind":"symbol","type":"topic","title":"defaultScope","url":"\/documentation\/auth0\/defaultscope","abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}],"role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/foundation.json b/docs/data/documentation/auth0/foundation.json index d2d6bb92..37db1f75 100644 --- a/docs/data/documentation/auth0/foundation.json +++ b/docs/data/documentation/auth0/foundation.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:m:s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","roleHeading":"Extended Module","symbolKind":"extension","title":"Foundation","role":"collection","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation"]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"],"title":"Extended Structures"}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","navigatorTitle":[{"text":"Data","kind":"identifier"}],"title":"Data","type":"topic","abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"Data","kind":"identifier","preciseIdentifier":"s:10Foundation4DataV"}],"url":"\/documentation\/auth0\/foundation\/data","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"kind":"symbol","abstract":[],"role":"collection","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","url":"\/documentation\/auth0\/foundation","title":"Foundation"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/foundation"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"title":"Extended Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"]}],"metadata":{"externalID":"s:m:s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","role":"collection","modules":[{"name":"Auth0"}],"roleHeading":"Extended Module","title":"Foundation","symbolKind":"extension"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"type":"topic","title":"Foundation","kind":"symbol","url":"\/documentation\/auth0\/foundation","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"navigatorTitle":[{"text":"Data","kind":"identifier"}],"type":"topic","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"title":"Data","kind":"symbol","url":"\/documentation\/auth0\/foundation\/data","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 54c3db9a..1bab1397 100644 --- a/docs/data/documentation/auth0/foundation/data.json +++ b/docs/data/documentation/auth0/foundation/data.json @@ -1 +1 @@ -{"metadata":{"navigatorTitle":[{"text":"Data","kind":"identifier"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"Data","externalID":"s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","extendedModule":"Foundation","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"identifier"}],"roleHeading":"Extended Structure","role":"symbol","symbolKind":"extension"},"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"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()"],"title":"Instance Methods"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation\/data"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"kind":"symbol","abstract":[],"role":"collection","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","url":"\/documentation\/auth0\/foundation","title":"Foundation"},"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."}],"fragments":[{"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"}],"url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","navigatorTitle":[{"text":"Data","kind":"identifier"}],"title":"Data","type":"topic","abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"Data","kind":"identifier","preciseIdentifier":"s:10Foundation4DataV"}],"url":"\/documentation\/auth0\/foundation\/data","kind":"symbol","role":"symbol"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/foundation\/data"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","extendedModule":"Foundation","navigatorTitle":[{"kind":"identifier","text":"Data"}],"externalID":"s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","roleHeading":"Extended Structure","title":"Data","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"symbolKind":"extension","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"text":"Adds a utility method for encoding data to base64url.","type":"text"}],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"type":"topic","title":"Foundation","kind":"symbol","url":"\/documentation\/auth0\/foundation","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"abstract":[{"type":"text","text":"Encodes data to base64url."}],"title":"a0_encodeBase64URLSafe()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"navigatorTitle":[{"text":"Data","kind":"identifier"}],"type":"topic","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"title":"Data","kind":"symbol","url":"\/documentation\/auth0\/foundation\/data","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"role":"symbol"}}} \ 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 e48fba48..f98f1c11 100644 --- a/docs/data/documentation/auth0/foundation/data/a0_encodebase64urlsafe().json +++ b/docs/data/documentation/auth0/foundation/data/a0_encodebase64urlsafe().json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Encodes data to base64url.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","roleHeading":"Instance Method","symbolKind":"method","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"extendedModule":"Foundation","title":"a0_encodeBase64URLSafe()","role":"symbol"},"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."}],"fragments":[{"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"}],"url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"kind":"symbol","abstract":[],"role":"collection","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","url":"\/documentation\/auth0\/foundation","title":"Foundation"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","navigatorTitle":[{"text":"Data","kind":"identifier"}],"title":"Data","type":"topic","abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"Data","kind":"identifier","preciseIdentifier":"s:10Foundation4DataV"}],"url":"\/documentation\/auth0\/foundation\/data","kind":"symbol","role":"symbol"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"]]},"metadata":{"roleHeading":"Instance Method","title":"a0_encodeBase64URLSafe()","symbolKind":"method","extendedModule":"Foundation","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"externalID":"s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Encodes data to base64url."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"abstract":[{"type":"text","text":"Encodes data to base64url."}],"title":"a0_encodeBase64URLSafe()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"type":"topic","title":"Foundation","kind":"symbol","url":"\/documentation\/auth0\/foundation","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"navigatorTitle":[{"text":"Data","kind":"identifier"}],"type":"topic","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"title":"Data","kind":"symbol","url":"\/documentation\/auth0\/foundation\/data","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"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 08a82c6d..f7fd82eb 100644 --- a/docs/data/documentation/auth0/jwk.json +++ b/docs/data/documentation/auth0/jwk.json @@ -1 +1 @@ -{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]}],"abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWK","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/jwk"],"traits":[{"interfaceLanguage":"swift"}]}],"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"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"},"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"title":"Conforms To","type":"conformsTo"}],"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWK"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","externalID":"s:5Auth03JWKV","symbolKind":"struct","modules":[{"name":"Auth0"}],"roleHeading":"Structure","title":"JWK"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"abstract":[],"url":"\/documentation\/auth0\/jwk\/init(from:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","type":"topic"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/jwk\/usage","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"text":"How the key is meant to be used.","type":"text"}],"title":"usage","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","title":"JWKS"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certUrl"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","url":"\/documentation\/auth0\/jwk\/certurl","type":"topic","abstract":[{"text":"The URL of the x.509 certificate.","type":"text"}],"kind":"symbol","title":"certUrl"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The type of key."}],"url":"\/documentation\/auth0\/jwk\/keytype","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","type":"topic","title":"keyType"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"title":"certChain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","url":"\/documentation\/auth0\/jwk\/certchain","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"certChain","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}],"kind":"symbol","role":"symbol","abstract":[{"text":"The x.509 certificate chain.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The exponent of the key."}],"url":"\/documentation\/auth0\/jwk\/exponent","title":"exponent","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"url":"\/documentation\/auth0\/jwk\/modulus","type":"topic","abstract":[{"text":"The modulus of the key.","type":"text"}],"role":"symbol","title":"modulus","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"title":"keyId","url":"\/documentation\/auth0\/jwk\/keyid","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","type":"topic","abstract":[{"text":"The unique identifier of the key.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","abstract":[{"type":"text","text":"The algorithm of the key."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","title":"algorithm","url":"\/documentation\/auth0\/jwk\/algorithm","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"kind":"symbol","title":"certThumbprint","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/jwk\/certthumbprint","abstract":[{"text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint).","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"],"title":"Related Documentation"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWK"}],"languages":["swift"]}]}],"metadata":{"externalID":"s:5Auth03JWKV","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"JWK","kind":"identifier"}],"symbolKind":"struct","modules":[{"name":"Auth0"}],"roleHeading":"Structure","title":"JWK"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk"]}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"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"]}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"title":"Conforms To","kind":"relationships","type":"conformsTo"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"certThumbprint","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"certThumbprint","url":"\/documentation\/auth0\/jwk\/certthumbprint","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"url":"\/documentation\/auth0\/jwk\/modulus","title":"modulus","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"modulus","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"text":"The modulus of the key.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"abstract":[{"text":"How the key is meant to be used.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"usage","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"usage","url":"\/documentation\/auth0\/jwk\/usage","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"certUrl","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"certUrl","url":"\/documentation\/auth0\/jwk\/certurl","kind":"symbol"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"type":"topic","url":"\/documentation\/auth0\/jwks","abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"title":"JWKS","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"abstract":[{"text":"The x.509 certificate chain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"certChain","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?","kind":"text"}],"role":"symbol","type":"topic","title":"certChain","url":"\/documentation\/auth0\/jwk\/certchain","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"abstract":[{"type":"text","text":"The algorithm of the key."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"algorithm","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"algorithm","url":"\/documentation\/auth0\/jwk\/algorithm","kind":"symbol"},"doc://com.auth0.Auth0/SE":{"identifier":"doc:\/\/com.auth0.Auth0\/SE","type":"unresolvable","title":"Swift.Encodable"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"abstract":[{"text":"The unique identifier of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"keyId","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"keyId","url":"\/documentation\/auth0\/jwk\/keyid","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol","type":"topic","title":"init(from:)","url":"\/documentation\/auth0\/jwk\/init(from:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"abstract":[{"text":"The exponent of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"exponent","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"exponent","url":"\/documentation\/auth0\/jwk\/exponent","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"abstract":[{"type":"text","text":"The type of key."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"keyType","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","type":"topic","title":"keyType","url":"\/documentation\/auth0\/jwk\/keytype","kind":"symbol"}}} \ 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 1f0fb5d4..bc36dd8b 100644 --- a/docs/data/documentation/auth0/jwk/algorithm.json +++ b/docs/data/documentation/auth0/jwk/algorithm.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/jwk\/algorithm"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"algorithm","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"The algorithm of the key."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"algorithm","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth03JWKV9algorithmSSSgvp","symbolKind":"property","title":"algorithm"},"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","abstract":[{"type":"text","text":"The algorithm of the key."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","title":"algorithm","url":"\/documentation\/auth0\/jwk\/algorithm","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"metadata":{"role":"symbol","symbolKind":"property","externalID":"s:5Auth03JWKV9algorithmSSSgvp","modules":[{"name":"Auth0"}],"title":"algorithm","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"algorithm","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/algorithm"]}],"abstract":[{"type":"text","text":"The algorithm of the key."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"abstract":[{"type":"text","text":"The algorithm of the key."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"algorithm","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"algorithm","url":"\/documentation\/auth0\/jwk\/algorithm","kind":"symbol"}}} \ 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 45f3d1e9..40fde0f2 100644 --- a/docs/data/documentation/auth0/jwk/certchain.json +++ b/docs/data/documentation/auth0/jwk/certchain.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"certChain","kind":"identifier"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]?"}],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"title":"certChain","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certChain"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"externalID":"s:5Auth03JWKV9certChainSaySSGSgvp","symbolKind":"property","role":"symbol","roleHeading":"Instance Property"},"abstract":[{"type":"text","text":"The x.509 certificate chain."}],"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certchain"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"title":"certChain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","url":"\/documentation\/auth0\/jwk\/certchain","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"certChain","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}],"kind":"symbol","role":"symbol","abstract":[{"text":"The x.509 certificate chain.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth03JWKV9certChainSaySSGSgvp","title":"certChain","symbolKind":"property","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certChain"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certchain"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certChain","kind":"identifier"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]?","kind":"text"}],"languages":["swift"]}]}],"abstract":[{"text":"The x.509 certificate chain.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"abstract":[{"text":"The x.509 certificate chain.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"certChain","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?","kind":"text"}],"role":"symbol","type":"topic","title":"certChain","url":"\/documentation\/auth0\/jwk\/certchain","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]}}} \ 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 51adfd32..66b9900b 100644 --- a/docs/data/documentation/auth0/jwk/certthumbprint.json +++ b/docs/data/documentation/auth0/jwk/certthumbprint.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","interfaceLanguage":"swift"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/jwk\/certthumbprint"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"certThumbprint","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"metadata":{"title":"certThumbprint","role":"symbol","externalID":"s:5Auth03JWKV14certThumbprintSSSgvp","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"kind":"symbol","title":"certThumbprint","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/jwk\/certthumbprint","abstract":[{"text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint).","type":"text"}]}}} \ No newline at end of file +{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"certThumbprint","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"certThumbprint","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"certThumbprint","externalID":"s:5Auth03JWKV14certThumbprintSSSgvp"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certthumbprint"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"certThumbprint","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"certThumbprint","url":"\/documentation\/auth0\/jwk\/certthumbprint","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]}}} \ 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 0e13b94b..4a9701d1 100644 --- a/docs/data/documentation/auth0/jwk/certurl.json +++ b/docs/data/documentation/auth0/jwk/certurl.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"sections":[],"metadata":{"role":"symbol","title":"certUrl","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"certUrl","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","externalID":"s:5Auth03JWKV7certUrlSSSgvp","symbolKind":"property","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl"},"abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certUrl"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certurl"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certUrl"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","url":"\/documentation\/auth0\/jwk\/certurl","type":"topic","abstract":[{"text":"The URL of the x.509 certificate.","type":"text"}],"kind":"symbol","title":"certUrl"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"role":"symbol","externalID":"s:5Auth03JWKV7certUrlSSSgvp","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"certUrl","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"certUrl","symbolKind":"property"},"sections":[],"abstract":[{"text":"The URL of the x.509 certificate.","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl"},"variants":[{"paths":["\/documentation\/auth0\/jwk\/certurl"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"certUrl","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"certUrl","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"certUrl","url":"\/documentation\/auth0\/jwk\/certurl","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]}}} \ 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 417b38c5..859e9369 100644 --- a/docs/data/documentation/auth0/jwk/exponent.json +++ b/docs/data/documentation/auth0/jwk/exponent.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/exponent"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"text":"The exponent of the key.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"exponent","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","metadata":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"exponent","externalID":"s:5Auth03JWKV8exponentSSSgvp","role":"symbol","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The exponent of the key."}],"url":"\/documentation\/auth0\/jwk\/exponent","title":"exponent","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","role":"symbol","type":"topic"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"abstract":[{"type":"text","text":"The exponent of the key."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/exponent"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent"},"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth03JWKV8exponentSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"exponent","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"exponent","symbolKind":"property"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"exponent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"abstract":[{"text":"The exponent of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"exponent","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"exponent","url":"\/documentation\/auth0\/jwk\/exponent","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 74c38f7f..6e5dc6d7 100644 --- a/docs/data/documentation/auth0/jwk/init(from:).json +++ b/docs/data/documentation/auth0/jwk/init(from:).json @@ -1 +1 @@ -{"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/init(from:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)"},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Initializer","role":"symbol","externalID":"s:5Auth03JWKV4fromACs7Decoder_p_tKcfc","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"title":"init(from:)","symbolKind":"init"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"abstract":[],"url":"\/documentation\/auth0\/jwk\/init(from:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","type":"topic"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"code":"Decodable.init(from:)","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/jwk\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"metadata":{"fragments":[{"kind":"identifier","text":"init"},{"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"}],"title":"init(from:)","symbolKind":"init","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","role":"symbol","externalID":"s:5Auth03JWKV4fromACs7Decoder_p_tKcfc"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol","type":"topic","title":"init(from:)","url":"\/documentation\/auth0\/jwk\/init(from:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]}}} \ 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 41df1a9e..58740f4a 100644 --- a/docs/data/documentation/auth0/jwk/keyid.json +++ b/docs/data/documentation/auth0/jwk/keyid.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"keyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","title":"keyId","role":"symbol","externalID":"s:5Auth03JWKV5keyIdSSSgvp","symbolKind":"property","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/jwk\/keyid"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"The unique identifier of the key.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"title":"keyId","url":"\/documentation\/auth0\/jwk\/keyid","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","type":"topic","abstract":[{"text":"The unique identifier of the key.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]}}} \ No newline at end of file +{"metadata":{"title":"keyId","symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth03JWKV5keyIdSSSgvp","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"sections":[],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId"},"abstract":[{"type":"text","text":"The unique identifier of the key."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keyId"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/keyid"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"abstract":[{"text":"The unique identifier of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"keyId","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"keyId","url":"\/documentation\/auth0\/jwk\/keyid","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 8cd4dc94..88d001b3 100644 --- a/docs/data/documentation/auth0/jwk/keytype.json +++ b/docs/data/documentation/auth0/jwk/keytype.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/jwk\/keytype"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth03JWKV7keyTypeSSvp","title":"keyType"},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The type of key."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The type of key."}],"url":"\/documentation\/auth0\/jwk\/keytype","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","type":"topic","title":"keyType"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keyType"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth03JWKV7keyTypeSSvp","role":"symbol","roleHeading":"Instance Property","title":"keyType","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/keytype"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"abstract":[{"type":"text","text":"The type of key."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"abstract":[{"type":"text","text":"The type of key."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"keyType","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","type":"topic","title":"keyType","url":"\/documentation\/auth0\/jwk\/keytype","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]}}} \ 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 7e463e53..3a70f8bf 100644 --- a/docs/data/documentation/auth0/jwk/modulus.json +++ b/docs/data/documentation/auth0/jwk/modulus.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The modulus of the key."}],"metadata":{"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"modulus"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"modulus","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth03JWKV7modulusSSSgvp"},"variants":[{"paths":["\/documentation\/auth0\/jwk\/modulus"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"url":"\/documentation\/auth0\/jwk\/modulus","type":"topic","abstract":[{"text":"The modulus of the key.","type":"text"}],"role":"symbol","title":"modulus","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/modulus"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth03JWKV7modulusSSSgvp","roleHeading":"Instance Property","title":"modulus","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"modulus","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"symbolKind":"property"},"abstract":[{"type":"text","text":"The modulus of the key."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"url":"\/documentation\/auth0\/jwk\/modulus","title":"modulus","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"modulus","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"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 526d122c..27315ebb 100644 --- a/docs/data/documentation/auth0/jwk/usage.json +++ b/docs/data/documentation/auth0/jwk/usage.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"usage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/jwk\/usage"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"usage"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth03JWKV5usageSSSgvp","roleHeading":"Instance Property","title":"usage"},"abstract":[{"type":"text","text":"How the key is meant to be used."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","interfaceLanguage":"swift"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/jwk\/usage","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"text":"How the key is meant to be used.","type":"text"}],"title":"usage","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","role":"symbol"}}} \ No newline at end of file +{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"How the key is meant to be used."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"usage"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}]}],"kind":"declarations"}],"metadata":{"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"usage","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth03JWKV5usageSSSgvp","title":"usage","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/usage"]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"abstract":[{"text":"How the key is meant to be used.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"usage","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"usage","url":"\/documentation\/auth0\/jwk\/usage","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwks.json b/docs/data/documentation/auth0/jwks.json index 6765d815..f34f543d 100644 --- a/docs/data/documentation/auth0/jwks.json +++ b/docs/data/documentation/auth0/jwks.json @@ -1 +1 @@ -{"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"type":"conformsTo"}],"metadata":{"symbolKind":"struct","externalID":"s:5Auth04JWKSV","roleHeading":"Structure","title":"JWKS","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"variants":[{"paths":["\/documentation\/auth0\/jwks"],"traits":[{"interfaceLanguage":"swift"}]}],"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"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"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","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"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","title":"JWKS"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/jwks\/key(id:)","title":"key(id:)","type":"topic","abstract":[{"text":"Gets a key from the key set by its identifier (","type":"text"},{"code":"kid","type":"codeVoice"},{"text":").","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keys","kind":"identifier"},{"kind":"text","text":": ["},{"text":"JWK","preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"url":"\/documentation\/auth0\/jwks\/keys","type":"topic","title":"keys","abstract":[{"text":"The keys in the key set.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","role":"symbol"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","type":"topic","abstract":[],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"title":"init(from:)","role":"symbol","url":"\/documentation\/auth0\/jwks\/init(from:)"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}]}]}],"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"kind":"relationships"}],"metadata":{"modules":[{"name":"Auth0"}],"title":"JWKS","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWKS","kind":"identifier"}],"roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"symbolKind":"struct","role":"symbol","externalID":"s:5Auth04JWKSV"},"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:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"type":"topic","url":"\/documentation\/auth0\/jwks","abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"title":"JWKS","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"title":"key(id:)","abstract":[{"text":"Gets a key from the key set by its identifier (","type":"text"},{"code":"kid","type":"codeVoice"},{"text":").","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/jwks\/key(id:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"type":"topic","url":"\/documentation\/auth0\/jwks\/init(from:)","abstract":[],"title":"init(from:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"title":"keys","abstract":[{"type":"text","text":"The keys in the key set."}],"type":"topic","url":"\/documentation\/auth0\/jwks\/keys","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"keys","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets":{"type":"link","titleInlineContent":[{"text":"JSON Web Key Sets","type":"text"}],"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"}}} \ 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 fa9cd757..31de809a 100644 --- a/docs/data/documentation/auth0/jwks/init(from:).json +++ b/docs/data/documentation/auth0/jwks/init(from:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"title":"init(from:)","externalID":"s:5Auth04JWKSV4fromACs7Decoder_p_tKcfc","role":"symbol","roleHeading":"Initializer","symbolKind":"init"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/init(from:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","title":"JWKS"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","type":"topic","abstract":[],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"title":"init(from:)","role":"symbol","url":"\/documentation\/auth0\/jwks\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Decodable.init(from:)"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/jwks\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"metadata":{"symbolKind":"init","externalID":"s:5Auth04JWKSV4fromACs7Decoder_p_tKcfc","title":"init(from:)","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"type":"topic","url":"\/documentation\/auth0\/jwks\/init(from:)","abstract":[],"title":"init(from:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"type":"topic","url":"\/documentation\/auth0\/jwks","abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"title":"JWKS","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 a78c777c..4a196c8c 100644 --- a/docs/data/documentation/auth0/jwks/key(id:).json +++ b/docs/data/documentation/auth0/jwks/key(id:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/key(id:)"]}],"sections":[],"kind":"symbol","abstract":[{"text":"Gets a key from the key set by its identifier (","type":"text"},{"code":"kid","type":"codeVoice"},{"type":"text","text":")."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)"},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"key","kind":"identifier"},{"kind":"text","text":"("},{"text":"id","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"kid","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"kind":"text","text":"?"}]}],"kind":"declarations"}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"?"}],"roleHeading":"Instance Method","externalID":"s:5Auth04JWKSV3key2idAA3JWKVSgSS_tF","symbolKind":"method","extendedModule":"Auth0","title":"key(id:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","title":"JWKS"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/jwks\/key(id:)","title":"key(id:)","type":"topic","abstract":[{"text":"Gets a key from the key set by its identifier (","type":"text"},{"code":"kid","type":"codeVoice"},{"text":").","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)"},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Gets a key from the key set by its identifier ("},{"code":"kid","type":"codeVoice"},{"type":"text","text":")."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/key(id:)"]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"kid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"JWK","preciseIdentifier":"s:5Auth03JWKV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","extendedModule":"Auth0","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth03JWKV","text":"JWK","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"key(id:)","externalID":"s:5Auth04JWKSV3key2idAA3JWKVSgSS_tF","roleHeading":"Instance Method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"title":"key(id:)","abstract":[{"text":"Gets a key from the key set by its identifier (","type":"text"},{"code":"kid","type":"codeVoice"},{"text":").","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/jwks\/key(id:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"type":"topic","url":"\/documentation\/auth0\/jwks","abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"title":"JWKS","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]}}} \ 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 40253106..ab2afd09 100644 --- a/docs/data/documentation/auth0/jwks/keys.json +++ b/docs/data/documentation/auth0/jwks/keys.json @@ -1 +1 @@ -{"abstract":[{"text":"The keys in the key set.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keys"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:5Auth03JWKV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"typeIdentifier","text":"JWK"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/keys"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"metadata":{"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"keys"},{"kind":"text","text":": ["},{"text":"JWK","preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"role":"symbol","externalID":"s:5Auth04JWKSV4keysSayAA3JWKVGvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"keys"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"title":"JWK","url":"\/documentation\/auth0\/jwk","kind":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keys","kind":"identifier"},{"kind":"text","text":": ["},{"text":"JWK","preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"url":"\/documentation\/auth0\/jwks\/keys","type":"topic","title":"keys","abstract":[{"text":"The keys in the key set.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","title":"JWKS"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"metadata":{"role":"symbol","roleHeading":"Instance Property","title":"keys","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"text":"]","kind":"text"}],"externalID":"s:5Auth04JWKSV4keysSayAA3JWKVGvp","symbolKind":"property","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"The keys in the key set."}],"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"keys","kind":"identifier"},{"text":": [","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","text":"JWK","preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/jwks\/keys"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"title":"keys","abstract":[{"type":"text","text":"The keys in the key set."}],"type":"topic","url":"\/documentation\/auth0\/jwks\/keys","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"keys","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"symbol","type":"topic","role":"symbol","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"type":"topic","url":"\/documentation\/auth0\/jwks","abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"title":"JWKS","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loggable.json b/docs/data/documentation/auth0/loggable.json index 5fe285c6..b0272a21 100644 --- a/docs/data/documentation/auth0/loggable.json +++ b/docs/data/documentation/auth0/loggable.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","interfaceLanguage":"swift"},"kind":"symbol","topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger"],"title":"Instance Properties"},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)"]}],"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"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable"]}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Protocol","externalID":"s:5Auth08LoggableP","symbolKind":"protocol","role":"symbol","title":"Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"kind":"identifier","text":"Loggable"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"identifier":"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."}],"type":"topic","title":"logging(enabled:)","url":"\/documentation\/auth0\/loggable\/logging(enabled:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","role":"symbol","title":"Loggable","url":"\/documentation\/auth0\/loggable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","title":"logger","url":"\/documentation\/auth0\/loggable\/logger","abstract":[{"type":"text","text":"Logger used to print log statements."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"logger"},{"text":": ","kind":"text"},{"text":"Logger","preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"logger"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier","text":"Logger"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"title":"using(logger:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","url":"\/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."}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"protocol","externalID":"s:5Auth08LoggableP","modules":[{"name":"Auth0"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"title":"Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"roleHeading":"Protocol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable"]}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","interfaceLanguage":"swift"},"kind":"symbol","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"}],"sections":[],"relationshipsSections":[{"title":"Inherited By","type":"inheritedBy","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"kind":"relationships"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"type":"topic","title":"Loggable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/authentication":{"url":"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"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"abstract":[{"text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger.","type":"text"}],"kind":"symbol","role":"symbol","title":"using(logger:)","type":"topic","url":"\/documentation\/auth0\/loggable\/using(logger:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"text":"logger","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Logger","preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"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/Loggable/logging(enabled:)":{"abstract":[{"type":"text","text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses."}],"kind":"symbol","role":"symbol","title":"logging(enabled:)","type":"topic","url":"\/documentation\/auth0\/loggable\/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"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"abstract":[{"text":"Logger used to print log statements.","type":"text"}],"kind":"symbol","required":true,"role":"symbol","title":"logger","url":"\/documentation\/auth0\/loggable\/logger","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"logger","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"}}} \ 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 6ba0ba5f..1efd0e56 100644 --- a/docs/data/documentation/auth0/loggable/logger.json +++ b/docs/data/documentation/auth0/loggable/logger.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","interfaceLanguage":"swift"},"sections":[],"metadata":{"externalID":"s:5Auth08LoggableP6loggerAA6Logger_pSgvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP"},{"kind":"text","text":"?"}],"title":"logger","roleHeading":"Instance Property","required":true,"symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"Logger used to print log statements."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/logger"]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"logger"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","text":"Logger"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"set"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","title":"logger","url":"\/documentation\/auth0\/loggable\/logger","abstract":[{"type":"text","text":"Logger used to print log statements."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"logger"},{"text":": ","kind":"text"},{"text":"Logger","preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","title":"Logger","url":"\/documentation\/auth0\/logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Logger","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","role":"symbol","title":"Loggable","url":"\/documentation\/auth0\/loggable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}]}}} \ No newline at end of file +{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Logger used to print log statements."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"logger"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","text":"Logger","preciseIdentifier":"s:5Auth06LoggerP"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" ","kind":"text"},{"kind":"keyword","text":"set"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"metadata":{"externalID":"s:5Auth08LoggableP6loggerAA6Logger_pSgvp","modules":[{"name":"Auth0"}],"role":"symbol","title":"logger","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"logger"},{"text":": ","kind":"text"},{"text":"Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP"},{"text":"?","kind":"text"}],"required":true,"roleHeading":"Instance Property"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/logger"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Logger"}],"title":"Logger","kind":"symbol","url":"\/documentation\/auth0\/logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"type":"topic","title":"Loggable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"abstract":[{"text":"Logger used to print log statements.","type":"text"}],"kind":"symbol","required":true,"role":"symbol","title":"logger","url":"\/documentation\/auth0\/loggable\/logger","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"logger","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger"}}} \ 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 07613c8f..136ae348 100644 --- a/docs/data/documentation/auth0/loggable/logging(enabled:).json +++ b/docs/data/documentation/auth0/loggable/logging(enabled:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"enabled","content":[{"inlineContent":[{"text":"Flag to turn logging on\/off.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"By default all logging is "},{"inlineContent":[{"text":"disabled","type":"text"}],"type":"strong"},{"type":"text","text":"."}]}],"name":"Note","type":"aside"},{"content":[{"inlineContent":[{"text":"For the flag to take effect, logging should be turned on\/off ","type":"text"},{"type":"strong","inlineContent":[{"text":"before","type":"text"}]},{"type":"text","text":" making requests to Auth0."}],"type":"paragraph"}],"style":"important","type":"aside","name":"Important"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"abstract":[{"type":"text","text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses."}],"metadata":{"symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","title":"logging(enabled:)","externalID":"s:5Auth08LoggablePAAE7logging7enabledxSb_tF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"logging","kind":"identifier"},{"kind":"text","text":"("},{"text":"enabled","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"extendedModule":"Auth0"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/logging(enabled:)"]}],"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"identifier":"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."}],"type":"topic","title":"logging(enabled:)","url":"\/documentation\/auth0\/loggable\/logging(enabled:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","role":"symbol","title":"Loggable","url":"\/documentation\/auth0\/loggable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/loggable\/logging(enabled:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"kind":"symbol","metadata":{"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth08LoggablePAAE7logging7enabledxSb_tF","title":"logging(enabled:)","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"logging"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"name":"enabled","content":[{"inlineContent":[{"type":"text","text":"Flag to turn logging on\/off."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"By default all logging is "},{"type":"strong","inlineContent":[{"text":"disabled","type":"text"}]},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Note"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"For the flag to take effect, logging should be turned on\/off ","type":"text"},{"type":"strong","inlineContent":[{"text":"before","type":"text"}]},{"type":"text","text":" making requests to Auth0."}]}],"style":"important","name":"Important"}]}],"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","role":"symbol","title":"logging(enabled:)","type":"topic","url":"\/documentation\/auth0\/loggable\/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"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"type":"topic","title":"Loggable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"}}} \ 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 2327c97e..a48eed76 100644 --- a/docs/data/documentation/auth0/loggable/using(logger:).json +++ b/docs/data/documentation/auth0/loggable/using(logger:).json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"text":"(","kind":"text"},{"text":"logger","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Logger","preciseIdentifier":"s:5Auth06LoggerP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"logger","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Logger used to print log statements."}]}]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"By default all logging is "},{"type":"strong","inlineContent":[{"type":"text","text":"disabled"}]},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Note"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Logging should be turned on\/off ","type":"text"},{"inlineContent":[{"type":"text","text":"before"}],"type":"strong"},{"type":"text","text":" making request to Auth0 for the flag to take effect."}]}],"type":"aside","style":"important","name":"Important"}]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"logger"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Logger","preciseIdentifier":"s:5Auth06LoggerP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth08LoggablePAAE5using6loggerxAA6Logger_p_tF","symbolKind":"method","extendedModule":"Auth0","title":"using(logger:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"abstract":[{"text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)"},"variants":[{"paths":["\/documentation\/auth0\/loggable\/using(logger:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","role":"symbol","title":"Loggable","url":"\/documentation\/auth0\/loggable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"logger"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier","text":"Logger"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"title":"using(logger:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","url":"\/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."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","title":"Logger","url":"\/documentation\/auth0\/logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Logger","kind":"identifier"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"kind":"symbol","metadata":{"title":"using(logger:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"logger"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier","text":"Logger"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth08LoggablePAAE5using6loggerxAA6Logger_p_tF","extendedModule":"Auth0","role":"symbol","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"text":"logger","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Logger","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","preciseIdentifier":"s:5Auth06LoggerP"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"logger","content":[{"type":"paragraph","inlineContent":[{"text":"Logger used to print log statements.","type":"text"}]}]}]},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"By default all logging is "},{"type":"strong","inlineContent":[{"type":"text","text":"disabled"}]},{"text":".","type":"text"}]}],"type":"aside","name":"Note"},{"style":"important","name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"Logging should be turned on\/off ","type":"text"},{"inlineContent":[{"type":"text","text":"before"}],"type":"strong"},{"text":" making request to Auth0 for the flag to take effect.","type":"text"}]}],"type":"aside"}],"kind":"content"}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/loggable\/using(logger:)"],"traits":[{"interfaceLanguage":"swift"}]}],"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:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"type":"topic","title":"Loggable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Logger"}],"title":"Logger","kind":"symbol","url":"\/documentation\/auth0\/logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"abstract":[{"text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger.","type":"text"}],"kind":"symbol","role":"symbol","title":"using(logger:)","type":"topic","url":"\/documentation\/auth0\/loggable\/using(logger:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"text":"logger","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Logger","preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/logger.json b/docs/data/documentation/auth0/logger.json index bddec034..e9e7cd85 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"]]},"topicSections":[{"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:)"],"title":"Instance Methods"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger"]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Logger","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","metadata":{"externalID":"s:5Auth06LoggerP","roleHeading":"Protocol","title":"Logger","symbolKind":"protocol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"response"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?)"}],"url":"\/documentation\/auth0\/logger\/trace(response:data:)","title":"trace(response:data:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","type":"topic","required":true,"abstract":[{"text":"Log an HTTP response.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"request"},{"text":": ","kind":"text"},{"text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"trace(request:session:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","required":true,"url":"\/documentation\/auth0\/logger\/trace(request:session:)","type":"topic","abstract":[{"type":"text","text":"Log an HTTP request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"url"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":", "},{"text":"source","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"title":"trace(url:source:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","required":true,"url":"\/documentation\/auth0\/logger\/trace(url:source:)","type":"topic","abstract":[{"type":"text","text":"Log a URL."}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","title":"Logger","url":"\/documentation\/auth0\/logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Logger","kind":"identifier"}]}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"languages":["swift"]}]}],"sections":[],"metadata":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Logger"}],"title":"Logger","symbolKind":"protocol","modules":[{"name":"Auth0"}],"roleHeading":"Protocol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"role":"symbol","externalID":"s:5Auth06LoggerP"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"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:)"],"title":"Instance Methods"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"variants":[{"paths":["\/documentation\/auth0\/logger"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"url":"\/documentation\/auth0\/logger\/trace(response:data:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"response"},{"text":": ","kind":"text"},{"text":"URLResponse","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLResponse"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?)"}],"type":"topic","required":true,"kind":"symbol","role":"symbol","abstract":[{"text":"Log an HTTP response.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","title":"trace(response:data:)"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"title":"trace(url:source:)","type":"topic","required":true,"abstract":[{"text":"Log a URL.","type":"text"}],"url":"\/documentation\/auth0\/logger\/trace(url:source:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"text":"url","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"source"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Logger"}],"title":"Logger","kind":"symbol","url":"\/documentation\/auth0\/logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"request"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier","text":"URLRequest"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/logger\/trace(request:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","kind":"symbol","type":"topic","role":"symbol","abstract":[{"text":"Log an HTTP request.","type":"text"}],"title":"trace(request:session:)"}}} \ 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 20e583e2..263268e1 100644 --- a/docs/data/documentation/auth0/logger/trace(request:session:).json +++ b/docs/data/documentation/auth0/logger/trace(request:session:).json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"text":"request","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation10URLRequestV","text":"URLRequest","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":")"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(request:session:)"]}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"request"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"roleHeading":"Instance Method","externalID":"s:5Auth06LoggerP5trace7request7sessiony10Foundation10URLRequestV_So12NSURLSessionCtF","title":"trace(request:session:)"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Log an HTTP request."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"request"},{"text":": ","kind":"text"},{"text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"trace(request:session:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","required":true,"url":"\/documentation\/auth0\/logger\/trace(request:session:)","type":"topic","abstract":[{"type":"text","text":"Log an HTTP request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","title":"Logger","url":"\/documentation\/auth0\/logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Logger","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"text":"request","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLRequest","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation10URLRequestV"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Log an HTTP request."}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/logger\/trace(request:session:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"text":"request","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation10URLRequestV","text":"URLRequest","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"text":")","kind":"text"}],"externalID":"s:5Auth06LoggerP5trace7request7sessiony10Foundation10URLRequestV_So12NSURLSessionCtF","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","title":"trace(request:session:)"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"request"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier","text":"URLRequest"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/logger\/trace(request:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","kind":"symbol","type":"topic","role":"symbol","abstract":[{"text":"Log an HTTP request.","type":"text"}],"title":"trace(request:session:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Logger"}],"title":"Logger","kind":"symbol","url":"\/documentation\/auth0\/logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol"}}} \ 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 0ff0b423..35ce8943 100644 --- a/docs/data/documentation/auth0/logger/trace(response:data:).json +++ b/docs/data/documentation/auth0/logger/trace(response:data:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"text":"response","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"data","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?)","kind":"text"}],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"Log an HTTP response."}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"text":"response","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLResponse","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLResponse"},{"kind":"text","text":", "},{"text":"data","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"title":"trace(response:data:)","symbolKind":"method","externalID":"s:5Auth06LoggerP5trace8response4dataySo13NSURLResponseC_10Foundation4DataVSgtF","roleHeading":"Instance Method","required":true,"modules":[{"name":"Auth0"}],"role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/logger\/trace(response:data:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","title":"Logger","url":"\/documentation\/auth0\/logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Logger","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"response"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?)"}],"url":"\/documentation\/auth0\/logger\/trace(response:data:)","title":"trace(response:data:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","type":"topic","required":true,"abstract":[{"text":"Log an HTTP response.","type":"text"}],"role":"symbol"}}} \ No newline at end of file +{"metadata":{"required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"text":"response","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":"?)","kind":"text"}],"title":"trace(response:data:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","externalID":"s:5Auth06LoggerP5trace8response4dataySo13NSURLResponseC_10Foundation4DataVSgtF","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(response:data:)"]}],"abstract":[{"text":"Log an HTTP response.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"text":"response","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLResponse","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLResponse"},{"kind":"text","text":", "},{"kind":"externalParam","text":"data"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":"?)"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Logger"}],"title":"Logger","kind":"symbol","url":"\/documentation\/auth0\/logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"url":"\/documentation\/auth0\/logger\/trace(response:data:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"response"},{"text":": ","kind":"text"},{"text":"URLResponse","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLResponse"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?)"}],"type":"topic","required":true,"kind":"symbol","role":"symbol","abstract":[{"text":"Log an HTTP response.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","title":"trace(response:data:)"}}} \ 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 ebecfcfe..0ff27c17 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":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"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":", "},{"kind":"externalParam","text":"source"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"metadata":{"title":"trace(url:source:)","modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","externalID":"s:5Auth06LoggerP5trace3url6sourcey10Foundation3URLV_SSSgtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":", ","kind":"text"},{"text":"source","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"roleHeading":"Instance Method","required":true},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Log a URL.","type":"text"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/logger\/trace(url:source:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","title":"Logger","url":"\/documentation\/auth0\/logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Logger","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"url"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":", "},{"text":"source","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"title":"trace(url:source:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","required":true,"url":"\/documentation\/auth0\/logger\/trace(url:source:)","type":"topic","abstract":[{"type":"text","text":"Log a URL."}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","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"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"role":"symbol","symbolKind":"method","externalID":"s:5Auth06LoggerP5trace3url6sourcey10Foundation3URLV_SSSgtF","modules":[{"name":"Auth0"}],"required":true,"title":"trace(url:source:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"text":"url","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"source"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?)","kind":"text"}]},"variants":[{"paths":["\/documentation\/auth0\/logger\/trace(url:source:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Log a URL.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"title":"trace(url:source:)","type":"topic","required":true,"abstract":[{"text":"Log a URL.","type":"text"}],"url":"\/documentation\/auth0\/logger\/trace(url:source:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"text":"url","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"source"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Logger"}],"title":"Logger","kind":"symbol","url":"\/documentation\/auth0\/logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 48eeabaf..42616776 100644 --- a/docs/data/documentation/auth0/managementerror.json +++ b/docs/data/documentation/auth0/managementerror.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"ManagementError","symbolKind":"struct","roleHeading":"Structure","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"externalID":"s:5Auth015ManagementErrorV"},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror"]}],"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"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","interfaceLanguage":"swift"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"],"title":"Initializers"},{"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"]},{"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"],"title":"Default Implementations"}],"abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","title":"Auth0Error Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/managementerror\/cause","title":"cause","role":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/managementerror\/debugdescription","title":"debugDescription","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","type":"topic","role":"collectionGroup","title":"Equatable Implementations","abstract":[],"url":"\/documentation\/auth0\/managementerror\/equatable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/statuscode","title":"statusCode","type":"topic","role":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","title":"init(info:statusCode:)","role":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error"},"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/managementerror\/code","title":"code","role":"symbol","abstract":[{"type":"text","text":"The code of the error as a string."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"abstract":[{"text":"Additional information about the error.","type":"text"}],"url":"\/documentation\/auth0\/managementerror\/info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","title":"info","type":"topic"}}} \ No newline at end of file +{"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"},{"generated":true,"title":"Default Implementations","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"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","interfaceLanguage":"swift"},"sections":[],"metadata":{"title":"ManagementError","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"externalID":"s:5Auth015ManagementErrorV","role":"symbol","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"modules":[{"name":"Auth0"}],"symbolKind":"struct"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"kind":"symbol","relationshipsSections":[{"kind":"relationships","title":"Conforms To","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"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"title":"debugDescription","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/managementerror\/debugdescription","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","kind":"article","role":"collectionGroup","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Additional information about the error."}],"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":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}],"url":"\/documentation\/auth0\/managementerror\/info","title":"info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","abstract":[{"type":"text","text":"HTTP status code of the response."}],"url":"\/documentation\/auth0\/managementerror\/statuscode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"title":"statusCode","role":"symbol"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","role":"collectionGroup","abstract":[],"url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","title":"Auth0Error Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"title":"LocalizedError Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/managementerror\/cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","kind":"symbol","type":"topic","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"title":"cause","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"title":"init(info:statusCode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","type":"topic"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"type":"topic","abstract":[{"type":"text","text":"The code of the error as a string."}],"title":"code","url":"\/documentation\/auth0\/managementerror\/code","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/!=(_:_:).json b/docs/data/documentation/auth0/managementerror/!=(_:_:).json index 2eefd3ca..49a99275 100644 --- a/docs/data/documentation/auth0/managementerror/!=(_:_:).json +++ b/docs/data/documentation/auth0/managementerror/!=(_:_:).json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)"},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth015ManagementErrorV","title":"!=(_:_:)","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"role":"symbol","symbolKind":"op","roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"extendedModule":"Swift"},"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":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/!=(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"role":"symbol","kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","url":"\/documentation\/auth0\/managementerror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","type":"topic","role":"collectionGroup","title":"Equatable Implementations","abstract":[],"url":"\/documentation\/auth0\/managementerror\/equatable-implementations"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations"]]},"sections":[],"kind":"symbol","metadata":{"extendedModule":"Swift","roleHeading":"Operator","role":"symbol","symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth015ManagementErrorV","title":"!=(_:_:)"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"text":".","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","type":"topic","role":"symbol","kind":"symbol","abstract":[],"title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","kind":"article","role":"collectionGroup","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/==(_:_:).json b/docs/data/documentation/auth0/managementerror/==(_:_:).json index b146dd24..a12d5fd3 100644 --- a/docs/data/documentation/auth0/managementerror/==(_:_:).json +++ b/docs/data/documentation/auth0/managementerror/==(_:_:).json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":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"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","interfaceLanguage":"swift"},"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth015ManagementErrorV2eeoiySbAC_ACtFZ","roleHeading":"Operator","title":"==(_:_:)","extendedModule":"Auth0","symbolKind":"op","modules":[{"name":"Auth0"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"type":"topic","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:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/managementerror\/==(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","type":"topic","role":"collectionGroup","title":"Equatable Implementations","abstract":[],"url":"\/documentation\/auth0\/managementerror\/equatable-implementations"}}} \ No newline at end of file +{"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Operator","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"role":"symbol","title":"==(_:_:)","externalID":"s:5Auth015ManagementErrorV2eeoiySbAC_ACtFZ","symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"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":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/==(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","kind":"article","role":"collectionGroup","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"title":"==(_:_:)","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","url":"\/documentation\/auth0\/managementerror\/==(_:_:)","role":"symbol"}}} \ 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 89bc0d7f..fa64fd84 100644 --- a/docs/data/documentation/auth0/managementerror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/managementerror/auth0error-implementations.json @@ -1 +1 @@ -{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"],"title":"Instance Properties","generated":true}],"kind":"article","schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/auth0error-implementations"]}],"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Auth0Error Implementations"},"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\/Auth0Error-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"errorDescription","url":"\/documentation\/auth0\/managementerror\/errordescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"localizedDescription","url":"\/documentation\/auth0\/managementerror\/localizeddescription"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/auth0error-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"kind":"article","topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"],"generated":true,"title":"Instance Properties"}],"metadata":{"role":"collectionGroup","title":"Auth0Error Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"url":"\/documentation\/auth0\/managementerror\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","title":"localizedDescription","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/managementerror\/errordescription","title":"errorDescription","kind":"symbol"}}} \ 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 cb2cc4e0..2e637807 100644 --- a/docs/data/documentation/auth0/managementerror/cause.json +++ b/docs/data/documentation/auth0/managementerror/cause.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/cause"]}],"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","title":"cause","modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth015ManagementErrorV5causes0C0_pSgvp","role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/managementerror\/cause","title":"cause","role":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth015ManagementErrorV5causes0C0_pSgvp","symbolKind":"property","role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"title":"cause"},"identifier":{"interfaceLanguage":"swift","url":"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 "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/managementerror\/cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","kind":"symbol","type":"topic","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"title":"cause","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 47d1464d..a318d667 100644 --- a/docs/data/documentation/auth0/managementerror/code.json +++ b/docs/data/documentation/auth0/managementerror/code.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth015ManagementErrorV4codeSSvp","role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"code","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"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\/code"]}],"abstract":[{"type":"text","text":"The code of the error as a string."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/managementerror\/code","title":"code","role":"symbol","abstract":[{"type":"text","text":"The code of the error as a string."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","abstract":[{"type":"text","text":"The code of the error as a string."}],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"code","roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth015ManagementErrorV4codeSSvp","modules":[{"name":"Auth0"}],"role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","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"}],"platforms":["iOS"],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"type":"topic","abstract":[{"type":"text","text":"The code of the error as a string."}],"title":"code","url":"\/documentation\/auth0\/managementerror\/code","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"}}} \ 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 56beffb3..37c80e35 100644 --- a/docs/data/documentation/auth0/managementerror/debugdescription.json +++ b/docs/data/documentation/auth0/managementerror/debugdescription.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"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"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"style":"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"}],"name":"Important","type":"aside"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"roleHeading":"Instance Property","externalID":"s:5Auth015ManagementErrorV16debugDescriptionSSvp","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"debugDescription"},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/managementerror\/debugdescription","title":"debugDescription","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"role":"symbol","symbolKind":"property","externalID":"s:5Auth015ManagementErrorV16debugDescriptionSSvp","title":"debugDescription","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"Description of the error."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/debugdescription"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"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"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"name":"Important","style":"important","type":"aside","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"title":"debugDescription","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/managementerror\/debugdescription","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"}}} \ 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 98378053..6a0da5fe 100644 --- a/docs/data/documentation/auth0/managementerror/equatable-implementations.json +++ b/docs/data/documentation/auth0/managementerror/equatable-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/equatable-implementations"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","interfaceLanguage":"swift"},"metadata":{"title":"Equatable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"type":"topic","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:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","title":"==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/managementerror\/==(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"role":"symbol","kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","url":"\/documentation\/auth0\/managementerror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"],"generated":true}],"metadata":{"title":"Equatable Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","type":"topic","role":"symbol","kind":"symbol","abstract":[],"title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"title":"==(_:_:)","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","url":"\/documentation\/auth0\/managementerror\/==(_:_:)","role":"symbol"}}} \ 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 194015fc..d270d557 100644 --- a/docs/data/documentation/auth0/managementerror/errordescription.json +++ b/docs/data/documentation/auth0/managementerror/errordescription.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"title":"errorDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","roleHeading":"Instance Property","extendedModule":"Auth0","symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV"},"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"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","style":"important","name":"Important"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"errorDescription","url":"\/documentation\/auth0\/managementerror\/errordescription"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","title":"Auth0Error Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/errordescription"]}],"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":{"modules":[{"name":"Auth0"}],"title":"errorDescription","role":"symbol","symbolKind":"property","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Auth0","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"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","name":"Important","style":"important"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/managementerror\/errordescription","title":"errorDescription","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","role":"collectionGroup","abstract":[],"url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","title":"Auth0Error Implementations","kind":"article"}}} \ 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 ae752130..faaf8d4d 100644 --- a/docs/data/documentation/auth0/managementerror/failurereason.json +++ b/docs/data/documentation/auth0/managementerror/failurereason.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/failurereason"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"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":{"symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"role":"symbol","title":"failureReason","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":[{"beta":false,"deprecated":false,"introducedAt":"8.0","name":"iOS","unavailable":false},{"beta":false,"deprecated":false,"name":"macOS","unavailable":false,"introducedAt":"10.10"},{"unavailable":false,"beta":false,"introducedAt":"9.0","deprecated":false,"name":"tvOS"},{"introducedAt":"2.0","name":"watchOS","unavailable":false,"beta":false,"deprecated":false}],"extendedModule":"Foundation"},"kind":"symbol","sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason"},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","abstract":[],"type":"topic","title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/failurereason","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","type":"topic","abstract":[]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"title":"failureReason","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","role":"symbol","platforms":[{"name":"iOS","deprecated":false,"beta":false,"introducedAt":"8.0","unavailable":false},{"name":"macOS","unavailable":false,"introducedAt":"10.10","beta":false,"deprecated":false},{"name":"tvOS","introducedAt":"9.0","deprecated":false,"unavailable":false,"beta":false},{"beta":false,"unavailable":false,"name":"watchOS","introducedAt":"2.0","deprecated":false}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","symbolKind":"property"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/failurereason"]}],"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"title":"LocalizedError Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","title":"failureReason","type":"topic"}}} \ 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 6267b7aa..7c504fef 100644 --- a/docs/data/documentation/auth0/managementerror/helpanchor.json +++ b/docs/data/documentation/auth0/managementerror/helpanchor.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"text":".","type":"text"}],"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"platforms":[{"deprecated":false,"unavailable":false,"name":"iOS","introducedAt":"8.0","beta":false},{"beta":false,"introducedAt":"10.10","unavailable":false,"deprecated":false,"name":"macOS"},{"beta":false,"deprecated":false,"unavailable":false,"name":"tvOS","introducedAt":"9.0"},{"beta":false,"introducedAt":"2.0","deprecated":false,"unavailable":false,"name":"watchOS"}],"title":"helpAnchor","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","roleHeading":"Instance Property","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"symbolKind":"property","extendedModule":"Foundation","role":"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"}]},"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":[{"paths":["\/documentation\/auth0\/managementerror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"helpAnchor","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","url":"\/documentation\/auth0\/managementerror\/helpanchor","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","type":"topic","abstract":[]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/helpanchor"]}],"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":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"role":"symbol","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","symbolKind":"property","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"}],"platforms":[{"name":"iOS","deprecated":false,"introducedAt":"8.0","unavailable":false,"beta":false},{"unavailable":false,"deprecated":false,"beta":false,"name":"macOS","introducedAt":"10.10"},{"beta":false,"deprecated":false,"introducedAt":"9.0","name":"tvOS","unavailable":false},{"name":"watchOS","introducedAt":"2.0","unavailable":false,"beta":false,"deprecated":false}],"title":"helpAnchor","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","roleHeading":"Instance Property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"title":"helpAnchor","url":"\/documentation\/auth0\/managementerror\/helpanchor","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"title":"LocalizedError Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 2f22cce9..741050d7 100644 --- a/docs/data/documentation/auth0/managementerror/info.json +++ b/docs/data/documentation/auth0/managementerror/info.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/managementerror\/info"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"externalID":"s:5Auth015ManagementErrorV4infoSDySSypGvp","symbolKind":"property","title":"info"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","abstract":[{"text":"Additional information about the error.","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"abstract":[{"text":"Additional information about the error.","type":"text"}],"url":"\/documentation\/auth0\/managementerror\/info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","title":"info","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]}}} \ No newline at end of file +{"metadata":{"title":"info","externalID":"s:5Auth015ManagementErrorV4infoSDySSypGvp","role":"symbol","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"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"},{"text":"]","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","sections":[],"abstract":[{"text":"Additional information about the error.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/info"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Additional information about the error."}],"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":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}],"url":"\/documentation\/auth0\/managementerror\/info","title":"info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"}}} \ 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 23070423..6ba8a74a 100644 --- a/docs/data/documentation/auth0/managementerror/init(info:statuscode:).json +++ b/docs/data/documentation/auth0/managementerror/init(info:statuscode:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/init(info:statuscode:)"]}],"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"},{"kind":"text","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."}]}]},{"name":"statusCode","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP status code of the response.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A new ","type":"text"},{"type":"codeVoice","code":"ManagementError"},{"type":"text","text":"."}]}]}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"metadata":{"symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"kind":"text","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"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":")","kind":"text"}],"role":"symbol","externalID":"s:5Auth015ManagementErrorV4info10statusCodeACSDySSypG_Sitcfc","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","title":"init(info:statusCode:)"},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","title":"init(info:statusCode:)","role":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Initializer","modules":[{"name":"Auth0"}],"externalID":"s:5Auth015ManagementErrorV4info10statusCodeACSDySSypG_Sitcfc","symbolKind":"init","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"title":"init(info:statusCode:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"kind":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","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":"], "},{"kind":"externalParam","text":"statusCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"info","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"JSON response from Auth0."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP status code of the response."}]}],"name":"statusCode"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"A new ","type":"text"},{"type":"codeVoice","code":"ManagementError"},{"text":".","type":"text"}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/init(info:statuscode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"title":"init(info:statusCode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 bedbc610..59789e8c 100644 --- a/docs/data/documentation/auth0/managementerror/localizeddescription.json +++ b/docs/data/documentation/auth0/managementerror/localizeddescription.json @@ -1 +1 @@ -{"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"},"metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth015ManagementErrorV","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"symbolKind":"property","title":"localizedDescription","role":"symbol"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"style":"important","type":"aside","name":"Important","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"}]}],"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"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","title":"Auth0Error Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"localizedDescription","url":"\/documentation\/auth0\/managementerror\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"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"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"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"}]},{"type":"text","text":" only."}]}],"type":"aside","style":"important","name":"Important"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"localizedDescription","symbolKind":"property","extendedModule":"Auth0","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth015ManagementErrorV","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Description of the error.","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","role":"collectionGroup","abstract":[],"url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","title":"Auth0Error Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"url":"\/documentation\/auth0\/managementerror\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","title":"localizedDescription","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"}}} \ 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 dc04c672..04815c90 100644 --- a/docs/data/documentation/auth0/managementerror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/managementerror/localizederror-implementations.json @@ -1 +1 @@ -{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/localizederror-implementations"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"LocalizedError Implementations","roleHeading":"API Collection"},"topicSections":[{"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,"title":"Instance Properties"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"url":"\/documentation\/auth0\/managementerror\/recoverysuggestion","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic","title":"recoverySuggestion","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","abstract":[],"type":"topic","title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/failurereason","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"helpAnchor","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","url":"\/documentation\/auth0\/managementerror\/helpanchor","type":"topic","abstract":[]}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"},"kind":"article","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}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"LocalizedError Implementations","role":"collectionGroup"},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/localizederror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","title":"failureReason","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"url":"\/documentation\/auth0\/managementerror\/recoverysuggestion","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol","type":"topic","title":"recoverySuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"title":"helpAnchor","url":"\/documentation\/auth0\/managementerror\/helpanchor","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 0d7f32fb..118fb1f4 100644 --- a/docs/data/documentation/auth0/managementerror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/managementerror/recoverysuggestion.json @@ -1 +1 @@ -{"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":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Property","platforms":[{"beta":false,"name":"iOS","unavailable":false,"introducedAt":"8.0","deprecated":false},{"beta":false,"name":"macOS","introducedAt":"10.10","unavailable":false,"deprecated":false},{"deprecated":false,"name":"tvOS","unavailable":false,"introducedAt":"9.0","beta":false},{"name":"watchOS","unavailable":false,"beta":false,"deprecated":false,"introducedAt":"2.0"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Foundation","symbolKind":"property","title":"recoverySuggestion","role":"symbol","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"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/recoverysuggestion"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"url":"\/documentation\/auth0\/managementerror\/recoverysuggestion","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic","title":"recoverySuggestion","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","type":"topic","abstract":[]}}} \ No newline at end of file +{"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"symbolKind":"property","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","title":"recoverySuggestion","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","platforms":[{"beta":false,"unavailable":false,"deprecated":false,"name":"iOS","introducedAt":"8.0"},{"name":"macOS","deprecated":false,"beta":false,"introducedAt":"10.10","unavailable":false},{"name":"tvOS","unavailable":false,"introducedAt":"9.0","beta":false,"deprecated":false},{"name":"watchOS","deprecated":false,"introducedAt":"2.0","unavailable":false,"beta":false}],"roleHeading":"Instance Property"},"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion"},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/recoverysuggestion"],"traits":[{"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"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"url":"\/documentation\/auth0\/managementerror\/recoverysuggestion","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol","type":"topic","title":"recoverySuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"title":"LocalizedError Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","type":"topic"}}} \ 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 5fcf9a48..b00eb8df 100644 --- a/docs/data/documentation/auth0/managementerror/statuscode.json +++ b/docs/data/documentation/auth0/managementerror/statuscode.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"metadata":{"symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","title":"statusCode","externalID":"s:5Auth015ManagementErrorV10statusCodeSivp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/statuscode"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/statuscode","title":"statusCode","type":"topic","role":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"HTTP status code of the response."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/statuscode"]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth015ManagementErrorV10statusCodeSivp","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"title":"statusCode","roleHeading":"Instance Property"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","abstract":[{"type":"text","text":"HTTP status code of the response."}],"url":"\/documentation\/auth0\/managementerror\/statuscode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"title":"statusCode","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementobject.json b/docs/data/documentation/auth0/managementobject.json index 89322e6d..6ffa80f8 100644 --- a/docs/data/documentation/auth0/managementobject.json +++ b/docs/data/documentation/auth0/managementobject.json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"metadata":{"title":"ManagementObject","modules":[{"name":"Auth0"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"externalID":"s:5Auth016ManagementObjecta","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"role":"symbol","symbolKind":"typealias","roleHeading":"Type Alias"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/managementobject"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"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":" "},{"text":"ManagementObject","kind":"identifier"},{"text":" = [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"},{"kind":"text","text":" = ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"role":"symbol","externalID":"s:5Auth016ManagementObjecta","roleHeading":"Type Alias","symbolKind":"typealias","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"modules":[{"name":"Auth0"}],"title":"ManagementObject","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","interfaceLanguage":"swift"},"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/managementobject"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementresult.json b/docs/data/documentation/auth0/managementresult.json index 871a813c..cd4570d9 100644 --- a/docs/data/documentation/auth0/managementresult.json +++ b/docs/data/documentation/auth0/managementresult.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementResult"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"kind":"text","text":"> = "},{"kind":"typeIdentifier","text":"Result","preciseIdentifier":"s:s6ResultO"},{"text":"<","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth016ManagementResulta1Txmfp","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"modules":[{"name":"Auth0"}],"title":"ManagementResult","role":"symbol","symbolKind":"typealias","roleHeading":"Type Alias","externalID":"s:5Auth016ManagementResulta","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementResult"}],"navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementresult"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","interfaceLanguage":"swift"},"abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Management API operations."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","url":"\/documentation\/auth0\/managementresult","type":"topic","title":"ManagementResult","kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Management API operations."}],"navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementResult"},{"text":"<","kind":"text"},{"kind":"genericParameter","text":"T"},{"text":"> = ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO","text":"Result"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth016ManagementResulta1Txmfp"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}]}]}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Type Alias","role":"symbol","title":"ManagementResult","navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"externalID":"s:5Auth016ManagementResulta","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"ManagementResult","kind":"identifier"}],"symbolKind":"typealias"},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","interfaceLanguage":"swift"},"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Management API operations.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementresult"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Management API operations."}],"url":"\/documentation\/auth0\/managementresult","navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","kind":"symbol","type":"topic","title":"ManagementResult","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype.json b/docs/data/documentation/auth0/passwordlesstype.json index 55f79cc1..c32a2353 100644 --- a/docs/data/documentation/auth0/passwordlesstype.json +++ b/docs/data/documentation/auth0/passwordlesstype.json @@ -1 +1 @@ -{"sections":[],"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"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"],"title":"Default Implementations","generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"symbolKind":"enum","externalID":"s:5Auth016PasswordlessTypeO","modules":[{"name":"Auth0"}],"title":"PasswordlessType","roleHeading":"Enumeration","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY"],"title":"Conforms To"}],"kind":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","type":"topic","abstract":[],"role":"collectionGroup","title":"Equatable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"}],"url":"\/documentation\/auth0\/passwordlesstype\/code","abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"type":"topic","role":"symbol","title":"PasswordlessType.code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/passwordlesstype\/androidlink","abstract":[{"type":"text","text":"Android App Link."}],"title":"PasswordlessType.androidLink","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"role":"collectionGroup","type":"topic","title":"RawRepresentable Implementations","abstract":[],"url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"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":")"}],"role":"symbol","type":"topic","title":"init(rawValue:)","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"},"doc://com.auth0.Auth0/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/com.auth0.Auth0\/SH","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}],"role":"symbol","type":"topic","title":"PasswordlessType.iOSLink","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","abstract":[{"text":"Universal Link.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Regular Web HTTP link (web only, uses a redirect).","type":"text"}],"url":"\/documentation\/auth0\/passwordlesstype\/weblink","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","title":"PasswordlessType.webLink","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/SY":{"title":"Swift.RawRepresentable","identifier":"doc:\/\/com.auth0.Auth0\/SY","type":"unresolvable"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"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"]},{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"]},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","metadata":{"roleHeading":"Enumeration","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"enum","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"title":"PasswordlessType","externalID":"s:5Auth016PasswordlessTypeO"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype"]}],"abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"abstract":[{"type":"text","text":"Android App Link."}],"kind":"symbol","title":"PasswordlessType.androidLink","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"url":"\/documentation\/auth0\/passwordlesstype\/androidlink","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"title":"PasswordlessType.iOSLink","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"iOSLink","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","kind":"symbol","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Universal Link."}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"type":"topic","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","title":"Equatable Implementations","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"abstract":[{"type":"text","text":"Regular Web HTTP link (web only, uses a redirect)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","title":"PasswordlessType.webLink","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/weblink","type":"topic"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"kind":"symbol","title":"init(rawValue:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"},"doc://com.auth0.Auth0/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SH"},"doc://com.auth0.Auth0/SY":{"title":"Swift.RawRepresentable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SY"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"title":"RawRepresentable Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"role":"symbol","title":"PasswordlessType.code","url":"\/documentation\/auth0\/passwordlesstype\/code","abstract":[{"text":"Simple OTP code sent by email or SMS.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","type":"topic","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json b/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json index d24e4d9e..fe448d51 100644 --- a/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json +++ b/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations"]]},"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"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"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"extendedModule":"Swift","roleHeading":"Operator","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth016PasswordlessTypeO","title":"!=(_:_:)","role":"symbol","symbolKind":"op"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","type":"topic","abstract":[],"role":"collectionGroup","title":"Equatable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","title":"!=(_:_:)","type":"topic"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/!=(_:_:)"]}],"kind":"symbol","metadata":{"title":"!=(_:_:)","role":"symbol","extendedModule":"Swift","symbolKind":"op","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"roleHeading":"Operator","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth016PasswordlessTypeO","modules":[{"relatedModules":["Swift"],"name":"Auth0"}]},"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"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","abstract":[],"title":"!=(_:_:)","type":"topic","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":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"type":"topic","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","title":"Equatable Implementations","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 68bc1269..aa1b87a4 100644 --- a/docs/data/documentation/auth0/passwordlesstype/androidlink.json +++ b/docs/data/documentation/auth0/passwordlesstype/androidlink.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/androidlink"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"abstract":[{"text":"Android App Link.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"androidLink"}],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"metadata":{"externalID":"s:5Auth016PasswordlessTypeO11androidLinkyA2CmF","roleHeading":"Case","modules":[{"name":"Auth0"}],"symbolKind":"case","title":"PasswordlessType.androidLink","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"androidLink"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/passwordlesstype\/androidlink","abstract":[{"type":"text","text":"Android App Link."}],"title":"PasswordlessType.androidLink","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Android App Link."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/androidlink"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"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\/androidLink"},"metadata":{"title":"PasswordlessType.androidLink","role":"symbol","symbolKind":"case","roleHeading":"Case","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"androidLink","kind":"identifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth016PasswordlessTypeO11androidLinkyA2CmF"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"abstract":[{"type":"text","text":"Android App Link."}],"kind":"symbol","title":"PasswordlessType.androidLink","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"url":"\/documentation\/auth0\/passwordlesstype\/androidlink","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 b65c8655..3bacc56a 100644 --- a/docs/data/documentation/auth0/passwordlesstype/code.json +++ b/docs/data/documentation/auth0/passwordlesstype/code.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"}],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","interfaceLanguage":"swift"},"sections":[],"abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"metadata":{"symbolKind":"case","externalID":"s:5Auth016PasswordlessTypeO4codeyA2CmF","roleHeading":"Case","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"PasswordlessType.code"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/code"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"}],"url":"\/documentation\/auth0\/passwordlesstype\/code","abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"type":"topic","role":"symbol","title":"PasswordlessType.code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"}],"platforms":["iOS"]}]}],"metadata":{"title":"PasswordlessType.code","externalID":"s:5Auth016PasswordlessTypeO4codeyA2CmF","symbolKind":"case","role":"symbol","roleHeading":"Case","modules":[{"name":"Auth0"}],"fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"role":"symbol","title":"PasswordlessType.code","url":"\/documentation\/auth0\/passwordlesstype\/code","abstract":[{"text":"Simple OTP code sent by email or SMS.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","type":"topic","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 a3291e0b..292b70de 100644 --- a/docs/data/documentation/auth0/passwordlesstype/equatable-implementations.json +++ b/docs/data/documentation/auth0/passwordlesstype/equatable-implementations.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"sections":[],"metadata":{"roleHeading":"API Collection","role":"collectionGroup","title":"Equatable Implementations","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/equatable-implementations"]}],"kind":"article","schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)"],"title":"Operators"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","title":"!=(_:_:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","interfaceLanguage":"swift"},"metadata":{"role":"collectionGroup","roleHeading":"API Collection","title":"Equatable Implementations","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/equatable-implementations"]}],"kind":"article","topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","abstract":[],"title":"!=(_:_:)","type":"topic","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":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 3b2019d8..0757c310 100644 --- a/docs/data/documentation/auth0/passwordlesstype/hash(into:).json +++ b/docs/data/documentation/auth0/passwordlesstype/hash(into:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hash(into:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"into"},{"text":" ","kind":"text"},{"text":"hasher","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"keyword","text":"inout"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:s6HasherV","text":"Hasher","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.hash(into:)"},{"text":".","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"]]},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"hash(into:)","symbolKind":"method","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth016PasswordlessTypeO","roleHeading":"Instance Method","role":"symbol","extendedModule":"Swift","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":"."}]}},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"kind":"text","text":"("},{"text":"into","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"title":"hash(into:)","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}]},"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"role":"collectionGroup","type":"topic","title":"RawRepresentable Implementations","abstract":[],"url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/hash(into:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"RawRepresentable.hash(into:)"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"hash","kind":"identifier"},{"kind":"text","text":"("},{"text":"into","kind":"externalParam"},{"kind":"text","text":" "},{"text":"hasher","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"],"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\/RawRepresentable-Implementations"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth016PasswordlessTypeO","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"extendedModule":"Swift","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"typeIdentifier","text":"Hasher","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"title":"hash(into:)","role":"symbol","conformance":{"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"text":" and ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":".","type":"text"}]},"roleHeading":"Instance Method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"title":"RawRepresentable Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"kind":"symbol","title":"hash(into:)","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","type":"topic","abstract":[],"conformance":{"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"},{"text":".","type":"text"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}]},"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","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"},{"kind":"text","text":")"}]}}} \ 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 44886fb3..6f6d9da3 100644 --- a/docs/data/documentation/auth0/passwordlesstype/hashvalue.json +++ b/docs/data/documentation/auth0/passwordlesstype/hashvalue.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth016PasswordlessTypeO","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"role":"symbol","extendedModule":"Swift","roleHeading":"Instance Property","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"text":".","type":"text"}]},"title":"hashValue"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"RawRepresentable.hashValue","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hashvalue"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","interfaceLanguage":"swift"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"title":"hashValue","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}]},"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"role":"collectionGroup","type":"topic","title":"RawRepresentable Implementations","abstract":[],"url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"}}} \ No newline at end of file +{"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"RawRepresentable.hashValue"},{"text":".","type":"text"}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"title":"hashValue","role":"symbol","roleHeading":"Instance Property","extendedModule":"Swift","externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth016PasswordlessTypeO","conformance":{"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"hashValue","kind":"identifier"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"symbolKind":"property"},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hashvalue"]}],"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\/hashValue","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"title":"hashValue","role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"title":"RawRepresentable Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 a4cc3f9c..20c8e3a7 100644 --- a/docs/data/documentation/auth0/passwordlesstype/init(rawvalue:).json +++ b/docs/data/documentation/auth0/passwordlesstype/init(rawvalue:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"RawRepresentable.init(rawValue:)","type":"codeVoice"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":")"}]}],"kind":"declarations"}],"metadata":{"roleHeading":"Initializer","symbolKind":"init","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth016PasswordlessTypeO8rawValueACSgSS_tcfc","title":"init(rawValue:)","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"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":")"}],"role":"symbol","type":"topic","title":"init(rawValue:)","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"]}],"abstract":[{"type":"text","text":"Inherited from "},{"code":"RawRepresentable.init(rawValue:)","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"rawValue"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"metadata":{"title":"init(rawValue:)","roleHeading":"Initializer","externalID":"s:5Auth016PasswordlessTypeO8rawValueACSgSS_tcfc","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"rawValue"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":")","kind":"text"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"kind":"symbol","title":"init(rawValue:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"}}} \ 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 1420f69b..4a22888f 100644 --- a/docs/data/documentation/auth0/passwordlesstype/ioslink.json +++ b/docs/data/documentation/auth0/passwordlesstype/ioslink.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Universal Link."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"iOSLink"}]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"iOSLink","kind":"identifier"}],"title":"PasswordlessType.iOSLink","modules":[{"name":"Auth0"}],"roleHeading":"Case","symbolKind":"case","externalID":"s:5Auth016PasswordlessTypeO7iOSLinkyA2CmF"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/ioslink"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}],"role":"symbol","type":"topic","title":"PasswordlessType.iOSLink","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","abstract":[{"text":"Universal Link.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"}}} \ No newline at end of file +{"metadata":{"title":"PasswordlessType.iOSLink","symbolKind":"case","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}],"externalID":"s:5Auth016PasswordlessTypeO7iOSLinkyA2CmF","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Case"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"kind":"identifier","text":"iOSLink"}]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/ioslink"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"abstract":[{"type":"text","text":"Universal Link."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"title":"PasswordlessType.iOSLink","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"iOSLink","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","kind":"symbol","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Universal Link."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]}}} \ 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 b875af2d..03fe5485 100644 --- a/docs/data/documentation/auth0/passwordlesstype/rawrepresentable-implementations.json +++ b/docs/data/documentation/auth0/passwordlesstype/rawrepresentable-implementations.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"]}],"sections":[],"kind":"article","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","interfaceLanguage":"swift"},"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"RawRepresentable Implementations","role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)"],"title":"Instance Methods","generated":true}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"kind":"text","text":"("},{"text":"into","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"title":"hash(into:)","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}]},"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"title":"hashValue","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}]},"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","type":"topic","abstract":[]}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"],"title":"Instance Properties","generated":true},{"generated":true,"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)"]}],"kind":"article","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"},"metadata":{"title":"RawRepresentable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup"},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"kind":"symbol","title":"hash(into:)","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","type":"topic","abstract":[],"conformance":{"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"},{"text":".","type":"text"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}]},"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","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"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"title":"hashValue","role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"type":"topic"}}} \ 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 294bfd6f..1cb0637d 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"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"webLink","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/weblink"]}],"sections":[],"metadata":{"role":"symbol","title":"PasswordlessType.webLink","modules":[{"name":"Auth0"}],"roleHeading":"Case","symbolKind":"case","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"webLink"}],"externalID":"s:5Auth016PasswordlessTypeO7webLinkyA2CmF"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Regular Web HTTP link (web only, uses a redirect)."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","type":"topic","title":"PasswordlessType","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Regular Web HTTP link (web only, uses a redirect).","type":"text"}],"url":"\/documentation\/auth0\/passwordlesstype\/weblink","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","title":"PasswordlessType.webLink","type":"topic"}}} \ No newline at end of file +{"kind":"symbol","abstract":[{"type":"text","text":"Regular Web HTTP link (web only, uses a redirect)."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webLink"}],"title":"PasswordlessType.webLink","symbolKind":"case","modules":[{"name":"Auth0"}],"roleHeading":"Case","role":"symbol","externalID":"s:5Auth016PasswordlessTypeO7webLinkyA2CmF"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"webLink","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/weblink"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"abstract":[{"type":"text","text":"Regular Web HTTP link (web only, uses a redirect)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","title":"PasswordlessType.webLink","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/weblink","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/refreshtokens.json b/docs/data/documentation/auth0/refreshtokens.json index 618c937d..cbaba0aa 100644 --- a/docs/data/documentation/auth0/refreshtokens.json +++ b/docs/data/documentation/auth0/refreshtokens.json @@ -1 +1 @@ -{"kind":"article","schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/refreshtokens"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"metadata":{"role":"article","roleHeading":"Article","modules":[{"name":"Auth0"}],"title":"Refresh Tokens: Common Errors"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"primaryContentSections":[{"content":[{"level":2,"anchor":"Overview","type":"heading","text":"Overview"},{"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":"paragraph"},{"text":"Unknown or invalid refresh token","type":"heading","anchor":"Unknown-or-invalid-refresh-token","level":2},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"Example error description:","type":"text"}]},{"type":"text","text":" "},{"code":"The credentials renewal failed. CAUSE: Unknown or invalid refresh token","type":"codeVoice"}]}]},{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Log event type:"}]},{"type":"text","text":" "},{"code":"fertft","type":"codeVoice"}],"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."}],"type":"paragraph"},{"type":"heading","text":"Common causes","anchor":"Common-causes","level":3},{"type":"heading","level":4,"anchor":"Renewing-the-credentials-after-revoking-the-refresh-token","text":"Renewing the credentials after revoking the refresh token"},{"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 "},{"type":"codeVoice","code":"credentials()"},{"type":"text","text":" method of the Credentials Manager in another thread."}]},{"type":"paragraph","inlineContent":[{"text":"Once a refresh token is revoked it can no longer be exchanged for new credentials.","type":"text"}]},{"level":4,"anchor":"Misconfiguration-of-the-absolute-lifetime-of-refresh-tokens","text":"Misconfiguration of the absolute lifetime of refresh tokens","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration"},{"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, 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.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"Once a refresh token expires it can no longer be exchanged for new credentials.","type":"text"}]},{"level":4,"type":"heading","anchor":"Misconfiguration-of-the-inactivity-lifetime-of-refresh-tokens","text":"Misconfiguration of the inactivity lifetime of refresh tokens"},{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","overridingTitle":"inactivity lifetime","type":"reference","overridingTitleInlineContent":[{"text":"inactivity lifetime","type":"text"}],"isActive":true},{"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":"text"},{"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"},{"text":" method of the Credentials Manager while your app is backgrounded.","type":"text"}]},{"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":"heading","level":2,"anchor":"Unsuccessful-Refresh-Token-exchange-reused-refresh-token-detected","text":"Unsuccessful Refresh Token exchange, reused refresh token detected"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"text":"Example error description:","type":"text"}]},{"type":"text","text":" "},{"code":"The credentials renewal failed. CAUSE: Unsuccessful Refresh Token exchange, reused refresh token detected","type":"codeVoice"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Log event type:"}]},{"text":" ","type":"text"},{"type":"codeVoice","code":"ferrt"}],"type":"paragraph"}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You might encounter this error if you have "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation"},{"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 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation"},{"type":"text","text":" has passed."}]},{"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":[{"type":"text","text":"In the absence of a bad actor, this error is typically a symptom of concurrency issues in your app."}]}]},{"anchor":"Common-causes","type":"heading","text":"Common causes","level":3},{"level":4,"anchor":"Multiple-Credentials-Manager-instances","type":"heading","text":"Multiple Credentials Manager instances"},{"type":"paragraph","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 "},{"code":"renew()","type":"codeVoice"},{"type":"text","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":"paragraph","inlineContent":[{"type":"text","text":"This can happen, for example, by using a computed property to get a Credentials Manager instance:"}]},{"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","level":4,"type":"heading"},{"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"}]},{"inlineContent":[{"type":"text","text":"To force a renewal, use the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","type":"reference","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","level":4,"text":"Using the Authentication API client to renew the credentials without synchronization","anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-without-synchronization"},{"type":"paragraph","inlineContent":[{"text":"If you are ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"not"}]},{"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"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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","titleInlineContent":[{"text":"absolute lifetime","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","title":"absolute lifetime","type":"link"},"https://auth0.com/docs/secure/tokens/refresh-tokens/refresh-token-rotation":{"titleInlineContent":[{"type":"text","text":"Refresh Token Rotation"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","type":"link","title":"Refresh Token Rotation","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation"},"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","titleInlineContent":[{"text":"reuse interval","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","title":"reuse interval","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"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"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","type":"topic","title":"renew(parameters:headers:callback:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","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."}]},{"text":"Unknown or invalid refresh token","level":2,"type":"heading","anchor":"Unknown-or-invalid-refresh-token"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"Example error description:"}],"type":"strong"},{"text":" ","type":"text"},{"type":"codeVoice","code":"The credentials renewal failed. CAUSE: Unknown or invalid refresh token"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"Log event type:","type":"text"}]},{"text":" ","type":"text"},{"type":"codeVoice","code":"fertft"}]}]}],"type":"unorderedList"},{"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"},{"level":3,"text":"Common causes","type":"heading","anchor":"Common-causes"},{"text":"Renewing the credentials after revoking the refresh token","level":4,"type":"heading","anchor":"Renewing-the-credentials-after-revoking-the-refresh-token"},{"inlineContent":[{"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 ","type":"text"},{"type":"codeVoice","code":"credentials()"},{"type":"text","text":" method of the Credentials Manager in another thread."}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Once a refresh token is revoked it can no longer be exchanged for new credentials."}]},{"type":"heading","anchor":"Misconfiguration-of-the-absolute-lifetime-of-refresh-tokens","level":4,"text":"Misconfiguration of the absolute lifetime of refresh tokens"},{"inlineContent":[{"type":"text","text":"The "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","isActive":true,"type":"reference"},{"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, 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.","type":"text"}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"text":"Once a refresh token expires it can no longer be exchanged for new credentials.","type":"text"}]},{"type":"heading","anchor":"Misconfiguration-of-the-inactivity-lifetime-of-refresh-tokens","level":4,"text":"Misconfiguration of the inactivity lifetime of refresh tokens"},{"inlineContent":[{"type":"text","text":"The "},{"isActive":true,"overridingTitleInlineContent":[{"type":"text","text":"inactivity lifetime"}],"overridingTitle":"inactivity lifetime","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","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 ","type":"text"},{"inlineContent":[{"text":"while the user is inactive","type":"text"}],"type":"emphasis"},{"type":"text","text":", your app may issue renewal requests with expired refresh tokens. This could happen, for example, when using the "},{"code":"credentials()","type":"codeVoice"},{"type":"text","text":" method of the Credentials Manager while your app is backgrounded."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"Once a refresh token expires due to user inactivity it can no longer be exchanged for new credentials."}],"type":"paragraph"},{"type":"heading","text":"Unsuccessful Refresh Token exchange, reused refresh token detected","anchor":"Unsuccessful-Refresh-Token-exchange-reused-refresh-token-detected","level":2},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"text":"Example error description:","type":"text"}]},{"type":"text","text":" "},{"type":"codeVoice","code":"The credentials renewal failed. CAUSE: Unsuccessful Refresh Token exchange, reused refresh token detected"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"Log event type:"}],"type":"strong"},{"type":"text","text":" "},{"code":"ferrt","type":"codeVoice"}]}]}]},{"type":"paragraph","inlineContent":[{"text":"You might encounter this error if you have ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","isActive":true},{"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."}]},{"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"}]}],"type":"paragraph"},{"type":"heading","anchor":"Common-causes","text":"Common causes","level":3},{"level":4,"text":"Multiple Credentials Manager instances","type":"heading","anchor":"Multiple-Credentials-Manager-instances"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you are using the Credentials Manager to renew the credentials -either through the "},{"type":"codeVoice","code":"credentials()"},{"text":" or the ","type":"text"},{"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:"}]},{"syntax":null,"type":"codeListing","code":["struct Services {"," \/\/ ❌ This will return a new instance every time"," var credentialsManager: CredentialsManager {"," return CredentialsManager(authentication: Auth0.authentication())"," }","}"]},{"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"},{"inlineContent":[{"type":"text","text":"If you are using the Credentials Manager to store and retrieve the credentials, you should not force renewals through the "},{"type":"codeVoice","code":"renew()"},{"text":" method of the Authentication API client. This method is not thread-safe, and may end up issuing renewal requests concurrently with the ","type":"text"},{"type":"codeVoice","code":"credentials()"},{"type":"text","text":" method of the Credentials Manager."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"To force a renewal, use the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","isActive":true,"type":"reference"},{"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."}],"type":"paragraph"},{"level":4,"type":"heading","anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-without-synchronization","text":"Using the Authentication API client to renew the credentials without synchronization"},{"type":"paragraph","inlineContent":[{"text":"If you are ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"not"}]},{"type":"text","text":" using the Credentials Manager, you need to implement proper synchronization to call the "},{"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"}]}]}],"metadata":{"roleHeading":"Article","role":"article","modules":[{"name":"Auth0"}],"title":"Refresh Tokens: Common Errors"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/refreshtokens"]}],"references":{"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","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","title":"reuse interval","titleInlineContent":[{"text":"reuse interval","type":"text"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens/refresh-token-rotation":{"type":"link","titleInlineContent":[{"text":"Refresh Token Rotation","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","title":"Refresh Token Rotation"},"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","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","title":"absolute lifetime","titleInlineContent":[{"text":"absolute lifetime","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}],"title":"renew(parameters:headers:callback:)","role":"symbol","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/request.json b/docs/data/documentation/auth0/request.json index a375214e..c0775456 100644 --- a/docs/data/documentation/auth0/request.json +++ b/docs/data/documentation/auth0/request.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Auth0 API request."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"},{"kind":"text","text":"<"},{"text":"T","kind":"genericParameter"},{"kind":"text","text":", "},{"kind":"genericParameter","text":"E"},{"kind":"text","text":"> "},{"text":"where","kind":"keyword"},{"text":" ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:5Auth00A8APIErrorP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"typeIdentifier","text":"Auth0APIError"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"code":["let request: Request = \/\/ ...","","request.start { result in"," print(result)","}"],"type":"codeListing","syntax":"swift"}]}],"kind":"symbol","topicSections":[{"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":"Instance Methods"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"],"title":"Type Aliases"}],"metadata":{"symbolKind":"struct","roleHeading":"Structure","title":"Request","role":"symbol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"externalID":"s:5Auth07RequestV","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV8Callbacka","kind":"typeIdentifier","text":"Callback"},{"text":")","kind":"text"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Performs the request.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","title":"start(_:)","type":"topic","url":"\/documentation\/auth0\/request\/start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"abstract":[{"text":"Combine publisher for the request.","type":"text"}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","role":"symbol","url":"\/documentation\/auth0\/request\/start()-132e1","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"text":">","kind":"text"}],"type":"topic","kind":"symbol","conformance":{"availabilityPrefix":[{"text":"Available when","type":"text"}],"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":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"title":"Request.Callback","url":"\/documentation\/auth0\/request\/callback","abstract":[{"text":"The callback closure type for the request.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Callback"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}],"title":"headers(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","role":"symbol","url":"\/documentation\/auth0\/request\/headers(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"abstract":[{"text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones.","type":"text"}],"title":"parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","role":"symbol","url":"\/documentation\/auth0\/request\/parameters(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"abstract":[{"text":"Performs the request.","type":"text"}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","role":"symbol","url":"\/documentation\/auth0\/request\/start()-8gjgk","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","conformance":{"constraints":[{"code":"E","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Auth0APIError","type":"codeVoice"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]}}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"},{"kind":"text","text":"<"},{"text":"T","kind":"genericParameter"},{"text":", ","kind":"text"},{"text":"E","kind":"genericParameter"},{"kind":"text","text":"> "},{"kind":"keyword","text":"where"},{"text":" ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth00A8APIErrorP"}]}]},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"type":"codeListing","syntax":"swift","code":["let request: Request = \/\/ ...","","request.start { result in"," print(result)","}"]}]}],"sections":[],"metadata":{"externalID":"s:5Auth07RequestV","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"symbolKind":"struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"title":"Request","role":"symbol","roleHeading":"Structure"},"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(_:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"],"title":"Type Aliases"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","interfaceLanguage":"swift"},"abstract":[{"text":"Auth0 API request.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"title":"start(_:)","type":"topic","abstract":[{"type":"text","text":"Performs the request."}],"url":"\/documentation\/auth0\/request\/start(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"("},{"text":"Callback","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV8Callbacka"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"title":"parameters(_:)","type":"topic","abstract":[{"text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones.","type":"text"}],"url":"\/documentation\/auth0\/request\/parameters(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"(["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"title":"headers(_:)","url":"\/documentation\/auth0\/request\/headers(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"headers"},{"kind":"text","text":"(["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","abstract":[{"type":"text","text":"Performs the request."}],"url":"\/documentation\/auth0\/request\/start()-8gjgk","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier"}],"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":[{"type":"text","text":"Available when"}]},"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}]},"title":"start()","type":"topic","abstract":[{"text":"Combine publisher for the request.","type":"text"}],"url":"\/documentation\/auth0\/request\/start()-132e1","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","url":"\/documentation\/auth0\/request\/callback","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"Callback","kind":"identifier"}],"title":"Request.Callback","abstract":[{"type":"text","text":"The callback closure type for the request."}],"navigatorTitle":[{"text":"Callback","kind":"identifier"}],"kind":"symbol","role":"symbol"}}} \ 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 c4788052..0980e822 100644 --- a/docs/data/documentation/auth0/request/callback.json +++ b/docs/data/documentation/auth0/request/callback.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth07RequestV8Callbacka","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"title":"Request.Callback","navigatorTitle":[{"text":"Callback","kind":"identifier"}],"symbolKind":"typealias","role":"symbol","roleHeading":"Type Alias"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"},{"kind":"text","text":" = ("},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","kind":"typeIdentifier","text":"E"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The callback closure type for the request."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/callback"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"title":"Request.Callback","url":"\/documentation\/auth0\/request\/callback","abstract":[{"text":"The callback closure type for the request.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Callback"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/callback"]}],"kind":"symbol","abstract":[{"type":"text","text":"The callback closure type for the request."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"Callback","kind":"identifier"},{"kind":"text","text":" = ("},{"kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO","text":"Result"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"}]}],"kind":"declarations"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"typealias","roleHeading":"Type Alias","externalID":"s:5Auth07RequestV8Callbacka","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"Callback","kind":"identifier"}],"title":"Request.Callback","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"Callback","kind":"identifier"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","url":"\/documentation\/auth0\/request\/callback","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"Callback","kind":"identifier"}],"title":"Request.Callback","abstract":[{"type":"text","text":"The callback closure type for the request."}],"navigatorTitle":[{"text":"Callback","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"}}} \ 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 a1d5bf59..22b0b02b 100644 --- a/docs/data/documentation/auth0/request/headers(_:).json +++ b/docs/data/documentation/auth0/request/headers(_:).json @@ -1 +1 @@ -{"abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"headers","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"extraHeaders"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","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"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"extraHeaders","content":[{"inlineContent":[{"type":"text","text":"Additional headers for the request."}],"type":"paragraph"}]}],"kind":"parameters"}],"kind":"symbol","metadata":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"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:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","externalID":"s:5Auth07RequestV7headersyACyxq_GSDyS2SGF","roleHeading":"Instance Method","title":"headers(_:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/headers(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}],"title":"headers(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","role":"symbol","url":"\/documentation\/auth0\/request\/headers(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"abstract":[{"type":"text","text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones."}],"variants":[{"paths":["\/documentation\/auth0\/request\/headers(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","interfaceLanguage":"swift"},"metadata":{"title":"headers(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth07RequestV7headersyACyxq_GSDyS2SGF","role":"symbol","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"headers"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"extraHeaders"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}]}]},{"parameters":[{"name":"extraHeaders","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers for the request."}]}]}],"kind":"parameters"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"title":"headers(_:)","url":"\/documentation\/auth0\/request\/headers(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"headers"},{"kind":"text","text":"(["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 5ae6bc2a..f7db07bb 100644 --- a/docs/data/documentation/auth0/request/parameters(_:).json +++ b/docs/data/documentation/auth0/request/parameters(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"extraParameters","kind":"internalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"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":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"parameters":[{"name":"extraParameters","content":[{"inlineContent":[{"type":"text","text":"Additional parameters for the request."}],"type":"paragraph"}]}],"kind":"parameters"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/request\/parameters(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"abstract":[{"text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones.","type":"text"}],"metadata":{"externalID":"s:5Auth07RequestV10parametersyACyxq_GSDySSypGF","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"title":"parameters(_:)","symbolKind":"method"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"abstract":[{"text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones.","type":"text"}],"title":"parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","role":"symbol","url":"\/documentation\/auth0\/request\/parameters(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/request\/parameters(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"extraParameters","kind":"internalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"extraParameters","content":[{"inlineContent":[{"text":"Additional parameters for the request.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"}],"metadata":{"role":"symbol","symbolKind":"method","title":"parameters(_:)","externalID":"s:5Auth07RequestV10parametersyACyxq_GSDySSypGF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"title":"parameters(_:)","type":"topic","abstract":[{"text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones.","type":"text"}],"url":"\/documentation\/auth0\/request\/parameters(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"(["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}]}}} \ 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 c0d9e738..17bc3980 100644 --- a/docs/data/documentation/auth0/request/start()-132e1.json +++ b/docs/data/documentation/auth0/request/start()-132e1.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A type-erased publisher."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/start()-132e1"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"metadata":{"symbolKind":"method","extendedModule":"Auth0","title":"start()","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"externalID":"s:5Auth07RequestV5start7Combine12AnyPublisherVyxq_GyF","modules":[{"name":"Auth0"}],"conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}]},"role":"symbol"},"abstract":[{"text":"Combine publisher for the request.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"abstract":[{"text":"Combine publisher for the request.","type":"text"}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","role":"symbol","url":"\/documentation\/auth0\/request\/start()-132e1","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"text":">","kind":"text"}],"type":"topic","kind":"symbol","conformance":{"availabilityPrefix":[{"text":"Available when","type":"text"}],"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":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]}}} \ 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\/Request"]]},"sections":[],"metadata":{"conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"conformancePrefix":[{"text":"Conforms when","type":"text"}]},"symbolKind":"method","title":"start()","externalID":"s:5Auth07RequestV5start7Combine12AnyPublisherVyxq_GyF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","extendedModule":"Auth0","role":"symbol","modules":[{"name":"Auth0"}]},"abstract":[{"text":"Combine publisher for the request.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/request\/start()-132e1"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier","text":"T"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}],"kind":"content"}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}]},"title":"start()","type":"topic","abstract":[{"text":"Combine publisher for the request.","type":"text"}],"url":"\/documentation\/auth0\/request\/start()-132e1","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"}}} \ 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 be05357c..c9509f99 100644 --- a/docs/data/documentation/auth0/request/start()-8gjgk.json +++ b/docs/data/documentation/auth0/request/start()-8gjgk.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"metadata":{"extendedModule":"Auth0","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","title":"start()","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","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"}],"externalID":"s:5Auth07RequestV5startxyYaKF","symbolKind":"method","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"type":"codeVoice","code":"E"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}]}},"abstract":[{"type":"text","text":"Performs the request."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/start()-8gjgk"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"}]}]},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"An error that conforms to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","isActive":true},{"text":"; either an ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"type":"text","text":" or a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Throws","type":"aside"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk"},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","title":"Auth0APIError","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"abstract":[{"text":"Performs the request.","type":"text"}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","role":"symbol","url":"\/documentation\/auth0\/request\/start()-8gjgk","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","conformance":{"constraints":[{"code":"E","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Auth0APIError","type":"codeVoice"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]}},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"abstract":[{"type":"text","text":"Performs the request."}],"sections":[],"metadata":{"roleHeading":"Instance Method","title":"start()","role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07RequestV5startxyYaKF","extendedModule":"Auth0","conformance":{"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"}]},"variants":[{"paths":["\/documentation\/auth0\/request\/start()-8gjgk"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error that conforms to "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"reference"},{"type":"text","text":"; either an "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" or a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","type":"reference","isActive":true},{"type":"text","text":"."}]}],"style":"note","name":"Throws","type":"aside"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","abstract":[{"type":"text","text":"Performs the request."}],"url":"\/documentation\/auth0\/request\/start()-8gjgk","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier"}],"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":[{"type":"text","text":"Available when"}]},"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"title":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"symbol","role":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 efe7c319..453ad3f1 100644 --- a/docs/data/documentation/auth0/request/start(_:).json +++ b/docs/data/documentation/auth0/request/start(_:).json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth07RequestV5startyyys6ResultOyxq_GcF","symbolKind":"method","role":"symbol","title":"start(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV8Callbacka","text":"Callback","kind":"typeIdentifier"},{"kind":"text","text":")"}]},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/start(_:)"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"abstract":[{"text":"Performs the request.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"kind":"text","text":" "},{"preciseIdentifier":"s:5Auth07RequestV8Callbacka","text":"Callback","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},{"text":")","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"text":"Callback that receives the result of the request when it completes.","type":"text"}]}]}],"kind":"parameters"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV8Callbacka","kind":"typeIdentifier","text":"Callback"},{"text":")","kind":"text"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Performs the request.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","title":"start(_:)","type":"topic","url":"\/documentation\/auth0\/request\/start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"title":"Request.Callback","url":"\/documentation\/auth0\/request\/callback","abstract":[{"text":"The callback closure type for the request.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Callback"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"abstract":[{"text":"Performs the request.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"kind":"text","text":" "},{"text":"Callback","preciseIdentifier":"s:5Auth07RequestV8Callbacka","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},{"kind":"text","text":")"}]}]},{"kind":"parameters","parameters":[{"name":"callback","content":[{"inlineContent":[{"text":"Callback that receives the result of the request when it completes.","type":"text"}],"type":"paragraph"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"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":{"symbolKind":"method","externalID":"s:5Auth07RequestV5startyyys6ResultOyxq_GcF","title":"start(_:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"(","kind":"text"},{"text":"Callback","preciseIdentifier":"s:5Auth07RequestV8Callbacka","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","url":"\/documentation\/auth0\/request\/callback","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"Callback","kind":"identifier"}],"title":"Request.Callback","abstract":[{"type":"text","text":"The callback closure type for the request."}],"navigatorTitle":[{"text":"Callback","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"title":"start(_:)","type":"topic","abstract":[{"type":"text","text":"Performs the request."}],"url":"\/documentation\/auth0\/request\/start(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"("},{"text":"Callback","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV8Callbacka"},{"text":")","kind":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/simplekeychain.json b/docs/data/documentation/auth0/simplekeychain.json index 00bbec02..187ec6af 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"]}],"sections":[],"metadata":{"symbolKind":"extension","externalID":"s:m:s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","role":"collection","roleHeading":"Extended Module","title":"SimpleKeychain","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/simplekeychain"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","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","kind":"symbol","role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain","kind":"symbol","role":"collection","abstract":[],"title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"metadata":{"title":"SimpleKeychain","role":"collection","externalID":"s:m:s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","symbolKind":"extension","roleHeading":"Extended Module","modules":[{"name":"Auth0"}]},"topicSections":[{"title":"Extended Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"text":"Conformance to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"role":"collection","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 cdc0af73..3845f6e2 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain.json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"text":"SimpleKeychain","kind":"typeIdentifier","preciseIdentifier":"s:14SimpleKeychainAAV"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}],"symbolKind":"extension","extendedModule":"SimpleKeychain","externalID":"s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","roleHeading":"Extended Structure","navigatorTitle":[{"text":"SimpleKeychain","kind":"identifier"}],"title":"SimpleKeychain"},"topicSections":[{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"]}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":".","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"},"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"],"type":"conformsTo"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"type":"topic","kind":"article","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","role":"collectionGroup","title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain","kind":"symbol","role":"collection","abstract":[],"title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","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","kind":"symbol","role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"],"title":"Default Implementations","generated":true}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"]]},"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"],"kind":"relationships"}],"abstract":[{"type":"text","text":"Conformance to "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference"},{"text":".","type":"text"}],"metadata":{"roleHeading":"Extended Structure","symbolKind":"extension","extendedModule":"SimpleKeychain","title":"SimpleKeychain","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"navigatorTitle":[{"text":"SimpleKeychain","kind":"identifier"}],"role":"symbol","externalID":"s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"typeIdentifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"text":"Conformance to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"role":"collection","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"role":"collectionGroup","kind":"article","type":"topic","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 04da098f..0490c54d 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/credentialsstorage-implementations.json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/credentialsstorage-implementations.json @@ -1 +1 @@ -{"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"CredentialsStorage Implementations"},"topicSections":[{"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,"title":"Instance Methods"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"kind":"symbol","role":"symbol","abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"title":"getEntry(forKey:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","abstract":[{"text":"Deletes a storage entry.","type":"text"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","role":"symbol","title":"deleteEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","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","kind":"symbol","role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Sets a storage entry."}],"title":"setEntry(_:forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain","kind":"symbol","role":"collection","abstract":[],"title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"}}} \ 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\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"sections":[],"metadata":{"role":"collectionGroup","roleHeading":"API Collection","title":"CredentialsStorage Implementations","modules":[{"name":"Auth0"}]},"topicSections":[{"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:)"],"title":"Instance Methods","generated":true}],"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"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"role":"collection","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"text":"Conformance to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","title":"getEntry(forKey:)","abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","abstract":[{"type":"text","text":"Deletes a storage entry."}],"title":"deleteEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"kind":"text","text":"("},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","abstract":[{"type":"text","text":"Sets a storage entry."}],"title":"setEntry(_:forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"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 291fa86c..cadd54af 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/deleteentry(forkey:).json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/deleteentry(forkey:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to delete from the Keychain."}]}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the data was deleted."}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","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"}],"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"externalID":"s:14SimpleKeychainAAV5Auth0E11deleteEntry6forKeySbSS_tF","extendedModule":"SimpleKeychain","role":"symbol","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"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)"]}],"abstract":[{"type":"text","text":"Deletes a storage entry."}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","abstract":[{"text":"Deletes a storage entry.","type":"text"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","role":"symbol","title":"deleteEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","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","kind":"symbol","role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"type":"topic","kind":"article","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","role":"collectionGroup","title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain","kind":"symbol","role":"collection","abstract":[],"title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"Deletes a storage entry."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"The key to delete from the Keychain.","type":"text"}],"type":"paragraph"}],"name":"key"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the data was deleted."}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/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"]]},"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}],"externalID":"s:14SimpleKeychainAAV5Auth0E11deleteEntry6forKeySbSS_tF","symbolKind":"method","roleHeading":"Instance Method","title":"deleteEntry(forKey:)","role":"symbol","extendedModule":"SimpleKeychain"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","abstract":[{"type":"text","text":"Deletes a storage entry."}],"title":"deleteEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"role":"collection","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"role":"collectionGroup","kind":"article","type":"topic","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"text":"Conformance to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain"}}} \ 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 14b2c353..b6992004 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/getentry(forkey:).json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/getentry(forkey:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","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","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to get from the Keychain."}]}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"inlineContent":[{"text":"The stored data.","type":"text"}],"type":"paragraph"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Retrieves a storage entry."}],"schemaVersion":{"minor":3,"major":0,"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","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"]]},"sections":[],"metadata":{"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"title":"getEntry(forKey:)","extendedModule":"SimpleKeychain","externalID":"s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","role":"symbol","roleHeading":"Instance Method","modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","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","kind":"symbol","role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"kind":"symbol","role":"symbol","abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"title":"getEntry(forKey:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain","kind":"symbol","role":"collection","abstract":[],"title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"type":"topic","kind":"article","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","role":"collectionGroup","title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","abstract":[]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"roleHeading":"Instance Method","title":"getEntry(forKey:)","externalID":"s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","role":"symbol","modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"extendedModule":"SimpleKeychain","symbolKind":"method"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getEntry"},{"kind":"text","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":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"text":"The key to get from the Keychain.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The stored data."}],"type":"paragraph"}]}],"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"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)"]}],"sections":[],"abstract":[{"type":"text","text":"Retrieves a storage entry."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","title":"getEntry(forKey:)","abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"role":"collectionGroup","kind":"article","type":"topic","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"text":"Conformance to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"role":"collection","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"}}} \ 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 bbc8d4d7..e310c95e 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/setentry(_:forkey:).json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/setentry(_:forkey:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"data"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":", "},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"data","content":[{"inlineContent":[{"type":"text","text":"The data to be stored."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"The key to store it to.","type":"text"}]}],"name":"key"}],"kind":"parameters"},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"If the data was stored.","type":"text"}]}],"kind":"content"}],"kind":"symbol","abstract":[{"text":"Sets a storage entry.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_: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"]]},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"metadata":{"modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}],"roleHeading":"Instance Method","role":"symbol","symbolKind":"method","extendedModule":"SimpleKeychain","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"kind":"text","text":"("},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":", ","kind":"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"}],"externalID":"s:14SimpleKeychainAAV5Auth0E8setEntry_6forKeySb10Foundation4DataV_SStF","title":"setEntry(_:forKey:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"type":"topic","kind":"article","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","role":"collectionGroup","title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Sets a storage entry."}],"title":"setEntry(_:forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain","kind":"symbol","role":"collection","abstract":[],"title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"url":"\/documentation\/auth0\/credentialsstorage","kind":"symbol","role":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"title":"CredentialsStorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","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","kind":"symbol","role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"type":"topic"}}} \ No newline at end of file +{"kind":"symbol","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":"Sets a storage entry."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"data","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"text":"forKey","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"The data to be stored.","type":"text"}],"type":"paragraph"}],"name":"data"},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to store it to."}]}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"If the data was stored."}],"type":"paragraph"}]}],"metadata":{"externalID":"s:14SimpleKeychainAAV5Auth0E8setEntry_6forKeySb10Foundation4DataV_SStF","modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"extendedModule":"SimpleKeychain","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"text":"(","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"setEntry(_:forKey:)","role":"symbol","roleHeading":"Instance Method"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"text":"Conformance to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"kind":"text","text":"("},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","abstract":[{"type":"text","text":"Sets a storage entry."}],"title":"setEntry(_:forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"role":"collection","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"role":"collectionGroup","kind":"article","type":"topic","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/swift.json b/docs/data/documentation/auth0/swift.json index 3412d594..72749ce3 100644 --- a/docs/data/documentation/auth0/swift.json +++ b/docs/data/documentation/auth0/swift.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","interfaceLanguage":"swift"},"sections":[],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"],"title":"Extended Structures"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/swift"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"externalID":"s:m:s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","roleHeading":"Extended Module","symbolKind":"extension","modules":[{"name":"Auth0"}],"title":"Swift","role":"collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"String","kind":"identifier","preciseIdentifier":"s:SS"}],"abstract":[{"text":"Adds a utility method for decoding base64url-encoded data, like ID tokens.","type":"text"}],"url":"\/documentation\/auth0\/swift\/string","title":"String","navigatorTitle":[{"kind":"identifier","text":"String"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"kind":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","role":"collection","title":"Swift","url":"\/documentation\/auth0\/swift"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/swift"]}],"sections":[],"metadata":{"role":"collection","title":"Swift","externalID":"s:m:s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","roleHeading":"Extended Module","symbolKind":"extension","modules":[{"name":"Auth0"}]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"],"title":"Extended Structures"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","kind":"symbol","role":"collection","title":"Swift","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"url":"\/documentation\/auth0\/swift\/string","role":"symbol","navigatorTitle":[{"text":"String","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"kind":"identifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","title":"String","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"}}} \ 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 35634fbc..67dba96f 100644 --- a/docs/data/documentation/auth0/swift/string.json +++ b/docs/data/documentation/auth0/swift/string.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"String","navigatorTitle":[{"kind":"identifier","text":"String"}],"externalID":"s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","roleHeading":"Extended Structure","symbolKind":"extension","extendedModule":"Swift","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:SS","text":"String","kind":"identifier"}],"role":"symbol"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"]]},"abstract":[{"text":"Adds a utility method for decoding base64url-encoded data, like ID tokens.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/swift\/string"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"kind":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","role":"collection","title":"Swift","url":"\/documentation\/auth0\/swift"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"String","kind":"identifier","preciseIdentifier":"s:SS"}],"abstract":[{"text":"Adds a utility method for decoding base64url-encoded data, like ID tokens.","type":"text"}],"url":"\/documentation\/auth0\/swift\/string","title":"String","navigatorTitle":[{"kind":"identifier","text":"String"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"type":"topic","abstract":[{"text":"Decodes base64url-encoded data.","type":"text"}],"url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","kind":"symbol","title":"a0_decodeBase64URLSafe()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"role":"symbol"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Extended Structure","role":"symbol","extendedModule":"Swift","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:SS","text":"String","kind":"identifier"}],"navigatorTitle":[{"text":"String","kind":"identifier"}],"title":"String","externalID":"s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","symbolKind":"extension"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"]]},"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"]}],"variants":[{"paths":["\/documentation\/auth0\/swift\/string"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"url":"\/documentation\/auth0\/swift\/string","role":"symbol","navigatorTitle":[{"text":"String","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"kind":"identifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","title":"String","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","kind":"symbol","role":"collection","title":"Swift","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","kind":"symbol","role":"symbol","title":"a0_decodeBase64URLSafe()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"a0_decodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Decodes base64url-encoded data."}]}}} \ 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 a1152e36..494b47c5 100644 --- a/docs/data/documentation/auth0/swift/string/a0_decodebase64urlsafe().json +++ b/docs/data/documentation/auth0/swift/string/a0_decodebase64urlsafe().json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"a0_decodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"languages":["swift"]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","interfaceLanguage":"swift"},"metadata":{"role":"symbol","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"text":"() -> ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"roleHeading":"Instance Method","title":"a0_decodeBase64URLSafe()","extendedModule":"Swift","symbolKind":"method","externalID":"s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF"},"abstract":[{"text":"Decodes base64url-encoded data.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"kind":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","role":"collection","title":"Swift","url":"\/documentation\/auth0\/swift"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"type":"topic","abstract":[{"text":"Decodes base64url-encoded data.","type":"text"}],"url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","kind":"symbol","title":"a0_decodeBase64URLSafe()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"String","kind":"identifier","preciseIdentifier":"s:SS"}],"abstract":[{"text":"Adds a utility method for decoding base64url-encoded data, like ID tokens.","type":"text"}],"url":"\/documentation\/auth0\/swift\/string","title":"String","navigatorTitle":[{"kind":"identifier","text":"String"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"a0_decodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"a0_decodeBase64URLSafe","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"roleHeading":"Instance Method","symbolKind":"method","title":"a0_decodeBase64URLSafe()","externalID":"s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"extendedModule":"Swift","role":"symbol"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"]]},"abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"url":"\/documentation\/auth0\/swift\/string","role":"symbol","navigatorTitle":[{"text":"String","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"kind":"identifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","title":"String","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","kind":"symbol","role":"symbol","title":"a0_decodeBase64URLSafe()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"a0_decodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Decodes base64url-encoded data."}]},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","kind":"symbol","role":"collection","title":"Swift","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","type":"topic","abstract":[]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/telemetry.json b/docs/data/documentation/auth0/telemetry.json index 9a6d3e3d..219d9eed 100644 --- a/docs/data/documentation/auth0/telemetry.json +++ b/docs/data/documentation/auth0/telemetry.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"struct","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"externalID":"s:5Auth09TelemetryV","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Telemetry","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"Telemetry"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()"],"title":"Initializers"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/telemetry"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"abstract":[{"text":"Initializer that generates a base64url-encoded value with telemetry data.","type":"text"}],"title":"init()","type":"topic","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"()","kind":"text"}],"url":"\/documentation\/auth0\/telemetry\/init()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/telemetry"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()"],"title":"Initializers"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},"metadata":{"title":"Telemetry","symbolKind":"struct","roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"externalID":"s:5Auth09TelemetryV","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"title":"init()","url":"\/documentation\/auth0\/telemetry\/init()","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"()"}]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"role":"symbol","url":"\/documentation\/auth0\/telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 1bb58091..6f8f487d 100644 --- a/docs/data/documentation/auth0/telemetry/init().json +++ b/docs/data/documentation/auth0/telemetry/init().json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/telemetry\/init()"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"()"}],"languages":["swift"]}]}],"metadata":{"roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"()"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth09TelemetryVACycfc","symbolKind":"init","title":"init()","role":"symbol"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"abstract":[{"text":"Initializer that generates a base64url-encoded value with telemetry data.","type":"text"}],"title":"init()","type":"topic","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"()","kind":"text"}],"url":"\/documentation\/auth0\/telemetry\/init()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"()","kind":"text"}],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","metadata":{"fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"()"}],"symbolKind":"init","roleHeading":"Initializer","title":"init()","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth09TelemetryVACycfc"},"variants":[{"paths":["\/documentation\/auth0\/telemetry\/init()"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Initializer that generates a base64url-encoded value with telemetry data.","type":"text"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"role":"symbol","url":"\/documentation\/auth0\/telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"title":"init()","url":"\/documentation\/auth0\/telemetry\/init()","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"()"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/trackable.json b/docs/data/documentation/auth0/trackable.json index f9b1d307..c88fcd40 100644 --- a/docs/data/documentation/auth0/trackable.json +++ b/docs/data/documentation/auth0/trackable.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"title":"Trackable","roleHeading":"Protocol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"externalID":"s:5Auth09TrackableP","symbolKind":"protocol","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable"]}],"sections":[],"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","title":"Inherited By","type":"inheritedBy"}],"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":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Trackable","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"title":"using(inLibrary:version:)","url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","type":"topic","abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"inLibrary","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"version"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"kind":"symbol","abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"role":"symbol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Trackable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","url":"\/documentation\/auth0\/trackable","title":"Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"tracking","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":")","kind":"text"}],"title":"tracking(enabled:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","url":"\/documentation\/auth0\/trackable\/tracking(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authentication","title":"Authentication","kind":"symbol","type":"topic","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}]},"https://auth0.com/docs/api/management/v2":{"type":"link","title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"url":"\/documentation\/auth0\/trackable\/telemetry","title":"telemetry","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"telemetry"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}],"abstract":[{"text":"The ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}],"required":true}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"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":[{"title":"Inherited By","type":"inheritedBy","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"kind":"relationships"}],"sections":[],"abstract":[{"text":"A type that can send the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header on every request to Auth0.","type":"text"}],"kind":"symbol","topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"]},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"metadata":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"roleHeading":"Protocol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth09TrackableP","title":"Trackable","role":"symbol","symbolKind":"protocol"},"references":{"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"role":"symbol","url":"\/documentation\/auth0\/telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"type":"topic","abstract":[{"type":"text","text":"Client for the "},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":"."}],"title":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"type":"topic","title":"Trackable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"role":"symbol","abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."},{"text":" ","type":"text"},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","url":"\/documentation\/auth0\/trackable\/tracking(enabled:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"tracking","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":")","kind":"text"}],"title":"tracking(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"abstract":[{"text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","title":"using(inLibrary:version:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"text":"inLibrary","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"version","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"title":"telemetry","role":"symbol","url":"\/documentation\/auth0\/trackable\/telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"telemetry"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","text":"Telemetry"}],"required":true,"abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},{"type":"text","text":" instance."}],"kind":"symbol"}}} \ 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 9151fec3..3256e6b0 100644 --- a/docs/data/documentation/auth0/trackable/telemetry.json +++ b/docs/data/documentation/auth0/trackable/telemetry.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"roleHeading":"Instance Property","title":"telemetry","externalID":"s:5Auth09TrackableP9telemetryAA9TelemetryVvp","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"telemetry"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","text":"Telemetry"}],"required":true},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"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"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"set","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"text":"The ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},{"text":" instance.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/trackable\/telemetry"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"url":"\/documentation\/auth0\/trackable\/telemetry","title":"telemetry","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"telemetry"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}],"abstract":[{"text":"The ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"kind":"symbol","abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"role":"symbol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Trackable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","url":"\/documentation\/auth0\/trackable","title":"Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","title":"Telemetry"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/telemetry"]}],"metadata":{"modules":[{"name":"Auth0"}],"title":"telemetry","role":"symbol","roleHeading":"Instance Property","required":true,"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"}],"externalID":"s:5Auth09TrackableP9telemetryAA9TelemetryVvp"},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","text":"Telemetry","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" ","kind":"text"},{"kind":"keyword","text":"set"},{"text":" }","kind":"text"}]}]}],"abstract":[{"text":"The ","type":"text"},{"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\/Trackable"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"title":"telemetry","role":"symbol","url":"\/documentation\/auth0\/trackable\/telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"telemetry"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","text":"Telemetry"}],"required":true,"abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},{"type":"text","text":" instance."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"role":"symbol","url":"\/documentation\/auth0\/telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"type":"topic","title":"Trackable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"}}} \ 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 3a1e2ae2..8aa10b5e 100644 --- a/docs/data/documentation/auth0/trackable/tracking(enabled:).json +++ b/docs/data/documentation/auth0/trackable/tracking(enabled:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"variants":[{"paths":["\/documentation\/auth0\/trackable\/tracking(enabled:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Turn on\/off sending the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."},{"text":" ","type":"text"},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"mutating"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tracking"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"languages":["swift"]}]},{"parameters":[{"name":"enabled","content":[{"inlineContent":[{"type":"text","text":"Flag to turn telemetry on\/off."}],"type":"paragraph"}]}],"kind":"parameters"}],"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tracking"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"title":"tracking(enabled:)","extendedModule":"Auth0","roleHeading":"Instance Method","externalID":"s:5Auth09TrackablePAAE8tracking7enabledySb_tF"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"tracking","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":")","kind":"text"}],"title":"tracking(enabled:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","url":"\/documentation\/auth0\/trackable\/tracking(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"kind":"symbol","abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"role":"symbol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Trackable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","url":"\/documentation\/auth0\/trackable","title":"Trackable"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"metadata":{"role":"symbol","externalID":"s:5Auth09TrackablePAAE8tracking7enabledySb_tF","extendedModule":"Auth0","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tracking"},{"kind":"text","text":"("},{"text":"enabled","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":")"}],"title":"tracking(enabled:)"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tracking"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":")","kind":"text"}]}]},{"parameters":[{"name":"enabled","content":[{"type":"paragraph","inlineContent":[{"text":"Flag to turn telemetry on\/off.","type":"text"}]}]}],"kind":"parameters"}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/tracking(enabled:)"]}],"abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header on every request to Auth0.","type":"text"},{"type":"text","text":" "},{"text":"By default we collect our libraries and SDKs versions to help us evaluate usage.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"role":"symbol","abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."},{"text":" ","type":"text"},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","url":"\/documentation\/auth0\/trackable\/tracking(enabled:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"tracking","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":")","kind":"text"}],"title":"tracking(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"type":"topic","title":"Trackable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 c51fd942..165bbf0d 100644 --- a/docs/data/documentation/auth0/trackable/using(inlibrary:version:).json +++ b/docs/data/documentation/auth0/trackable/using(inlibrary:version:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"variants":[{"paths":["\/documentation\/auth0\/trackable\/using(inlibrary:version:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"text":" ","kind":"text"},{"text":"name","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"version","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"name","content":[{"inlineContent":[{"type":"text","text":"Name of library or framework that uses Auth0.swift."}],"type":"paragraph"}]},{"name":"version","content":[{"inlineContent":[{"text":"Version of library or framework.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"}],"abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"externalID":"s:5Auth09TrackablePAAE5using9inLibrary7versionySS_SStF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"text":"inLibrary","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"version","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","role":"symbol","title":"using(inLibrary:version:)","roleHeading":"Instance Method","symbolKind":"method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"kind":"symbol","abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"role":"symbol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Trackable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","url":"\/documentation\/auth0\/trackable","title":"Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"title":"using(inLibrary:version:)","url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","type":"topic","abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"inLibrary","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"version"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"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"]]},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"mutating"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"text":"inLibrary","kind":"externalParam"},{"kind":"text","text":" "},{"text":"name","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"version"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":")","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Name of library or framework that uses Auth0.swift."}],"type":"paragraph"}],"name":"name"},{"name":"version","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Version of library or framework."}]}]}],"kind":"parameters"}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"text":"(","kind":"text"},{"text":"inLibrary","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"version"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"title":"using(inLibrary:version:)","symbolKind":"method","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","roleHeading":"Instance Method","role":"symbol","externalID":"s:5Auth09TrackablePAAE5using9inLibrary7versionySS_SStF"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/using(inlibrary:version:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"type":"topic","title":"Trackable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"abstract":[{"text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","title":"using(inLibrary:version:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"text":"inLibrary","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"version","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","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 415e2398..b3fdf227 100644 --- a/docs/data/documentation/auth0/useragents.json +++ b/docs/data/documentation/auth0/useragents.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"},"metadata":{"roleHeading":"Article","role":"article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"]}],"primaryContentSections":[{"kind":"content","content":[{"level":2,"anchor":"Overview","text":"Overview","type":"heading"},{"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"},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","type":"reference"},{"type":"text","text":" and "},{"identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","isActive":true,"type":"reference"},{"text":".","type":"text"}]},{"text":"When to use ASWebAuthenticationSession","anchor":"When-to-use-ASWebAuthenticationSession","type":"heading","level":2},{"inlineContent":[{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"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 "},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","isActive":true,"type":"reference"},{"text":" option.","type":"text"}],"type":"paragraph"},{"level":3,"type":"heading","text":"Without ephemeral sessions (the default)","anchor":"Without-ephemeral-sessions-the-default"},{"type":"codeListing","code":["Auth0"," .webAuth()"," .start { result in"," \/\/ ..."," }"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"By default, Auth0.swift uses "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" with "},{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"type":"text","text":" set to "},{"code":"false","type":"codeVoice"},{"text":". This means that:","type":"text"}],"type":"paragraph"},{"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’s not customizable."}]}]}]},{"anchor":"You-want-this-if","type":"heading","level":4,"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 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 "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" across "},{"type":"emphasis","inlineContent":[{"type":"text","text":"all"}]},{"text":" apps.","type":"text"}],"type":"paragraph"}]}],"type":"unorderedList"},{"text":"With ephemeral sessions","level":3,"type":"heading","anchor":"With-ephemeral-sessions"},{"inlineContent":[{"text":"Auth0.swift allows to set ","type":"text"},{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"type":"text","text":" to "},{"type":"codeVoice","code":"true"},{"text":", by calling ","type":"text"},{"type":"codeVoice","code":"useEphemeralSession()"},{"text":".","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .webAuth()"," .useEphemeralSession()"," .start { result in"," \/\/ ..."," }"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"code":"prefersEphemeralWebBrowserSession","type":"codeVoice"},{"type":"text","text":" being set to "},{"type":"codeVoice","code":"true"},{"type":"text","text":" means that:"}]},{"items":[{"content":[{"inlineContent":[{"text":"The session cookie will not be persisted. As soon as the ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" window closes, the cookie will be gone. This is akin to using a desktop browser in incognito mode."}],"type":"paragraph"}]},{"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":[{"text":"will not work","type":"text"}]},{"type":"text","text":"."}]}]},{"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":[{"inlineContent":[{"type":"text","text":"There will be no need to call "},{"code":"clearSession()","type":"codeVoice"},{"type":"text","text":". What "},{"type":"codeVoice","code":"clearSession()"},{"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":"paragraph"}]}],"type":"unorderedList"},{"level":4,"text":"You want this if…","type":"heading","anchor":"You-want-this-if"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"You don’t need SSO at all"}],"type":"strong"},{"text":". Since the session cookie won’t be persisted, SSO will be effectively disabled.","type":"text"}]}]},{"content":[{"inlineContent":[{"inlineContent":[{"text":"You don’t need any features that rely on the persistence of cookies","type":"text"}],"type":"strong"},{"text":", like “Remember this device”.","type":"text"}],"type":"paragraph"}]}],"type":"unorderedList"},{"level":2,"anchor":"When-to-use-SFSafariViewController","type":"heading","text":"When to use SFSafariViewController"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ..."," }"]},{"type":"paragraph","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":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"All the "},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" instances used in your app will have access to the persisted session cookie."}]}]},{"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":[{"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"}]}]},{"text":"You want this if…","type":"heading","level":4,"anchor":"You-want-this-if"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","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 another "},{"type":"codeVoice","code":"SFSafariViewController"},{"text":" instance in your app.","type":"text"}]}]}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"article","variants":[{"paths":["\/documentation\/auth0\/useragents"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"titleInlineContent":[{"text":"FAQ","type":"text"}],"title":"FAQ","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","type":"link"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession":{"title":"ASWebAuthenticationSession","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","titleInlineContent":[{"type":"codeVoice","code":"ASWebAuthenticationSession"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"titleInlineContent":[{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"}],"title":"prefersEphemeralWebBrowserSession","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller":{"title":"SFSafariViewController","identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","titleInlineContent":[{"type":"codeVoice","code":"SFSafariViewController"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","interfaceLanguage":"swift"},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"]}],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Overview","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Web-based authentication needs an in-app browser. Auth0.swift offers the choice of two system-provided browser APIs: "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","type":"reference"},{"type":"text","text":" and "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","type":"reference"},{"text":".","type":"text"}]},{"level":2,"type":"heading","text":"When to use ASWebAuthenticationSession","anchor":"When-to-use-ASWebAuthenticationSession"},{"inlineContent":[{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"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":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" can be used with or without ephemeral sessions enabled –through the ","type":"text"},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","isActive":true},{"text":" option.","type":"text"}],"type":"paragraph"},{"name":"Note","content":[{"type":"paragraph","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":"aside","style":"note"},{"level":3,"type":"heading","text":"Without ephemeral sessions (the default)","anchor":"Without-ephemeral-sessions-the-default"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .webAuth()"," .start { result in"," \/\/ ..."," }"]},{"inlineContent":[{"text":"By default, Auth0.swift uses ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" with ","type":"text"},{"code":"prefersEphemeralWebBrowserSession","type":"codeVoice"},{"text":" set to ","type":"text"},{"type":"codeVoice","code":"false"},{"text":". This means that:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The session cookie will be shared with the Safari app.","type":"text"}]}]},{"content":[{"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 "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":", not Auth0.swift, and unfortunately it is not customizable."}],"type":"paragraph"}]}],"type":"unorderedList"},{"level":4,"text":"You want this if…","anchor":"You-want-this-if","type":"heading"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"You need SSO between your app and your website"}],"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":[{"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"},{"type":"text","text":" across "},{"type":"emphasis","inlineContent":[{"type":"text","text":"all"}]},{"type":"text","text":" apps."}],"type":"paragraph"}]}]},{"type":"heading","level":3,"anchor":"With-ephemeral-sessions","text":"With ephemeral sessions"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0.swift allows to set "},{"code":"prefersEphemeralWebBrowserSession","type":"codeVoice"},{"type":"text","text":" to "},{"type":"codeVoice","code":"true"},{"text":", by calling ","type":"text"},{"type":"codeVoice","code":"useEphemeralSession()"},{"type":"text","text":"."}]},{"type":"codeListing","code":["Auth0"," .webAuth()"," .useEphemeralSession()"," .start { result in"," \/\/ ..."," }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"code":"prefersEphemeralWebBrowserSession","type":"codeVoice"},{"type":"text","text":" being set to "},{"type":"codeVoice","code":"true"},{"type":"text","text":" means that:"}]},{"items":[{"content":[{"inlineContent":[{"type":"text","text":"The session cookie will not be persisted. As soon as the "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" window closes, the cookie will be gone. This is akin to using a desktop browser in incognito mode.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Any features that rely on the persistence of cookies –like SSO, or “Remember this device”– "},{"type":"strong","inlineContent":[{"type":"text","text":"will not work"}]},{"text":".","type":"text"}]}]},{"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":"There will be no need to call ","type":"text"},{"code":"clearSession()","type":"codeVoice"},{"text":". What ","type":"text"},{"type":"codeVoice","code":"clearSession()"},{"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"},{"type":"text","text":" method of the Credentials Manager."}]}]}],"type":"unorderedList"},{"type":"heading","level":4,"text":"You want this if…","anchor":"You-want-this-if"},{"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":[{"type":"paragraph","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"}]}]}]},{"anchor":"When-to-use-SFSafariViewController","text":"When to use SFSafariViewController","level":2,"type":"heading"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ..."," }"]},{"type":"paragraph","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 "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" with and without ephemeral sessions. It persists cookies, but won’t share them outside of your app. This means that:","type":"text"}]},{"type":"unorderedList","items":[{"content":[{"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."}],"type":"paragraph"}]},{"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"},{"inlineContent":[{"text":"will work","type":"text"}],"type":"strong"},{"type":"text","text":" as expected."}]}]}]},{"name":"Note","style":"note","content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" does not support using Universal Links as callback URLs."}],"type":"paragraph"}],"type":"aside"},{"text":"You want this if…","type":"heading","anchor":"You-want-this-if","level":4},{"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"},{"type":"codeVoice","code":"SFSafariViewController"},{"text":" instance in your app.","type":"text"}]}]}]}]}],"metadata":{"role":"article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","modules":[{"name":"Auth0"}],"roleHeading":"Article"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/useragents"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"type":"link","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","title":"FAQ","titleInlineContent":[{"type":"text","text":"FAQ"}],"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"titleInlineContent":[{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","title":"prefersEphemeralWebBrowserSession","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller":{"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","title":"SFSafariViewController","titleInlineContent":[{"type":"codeVoice","code":"SFSafariViewController"}],"url":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession":{"titleInlineContent":[{"type":"codeVoice","code":"ASWebAuthenticationSession"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","title":"ASWebAuthenticationSession","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo.json b/docs/data/documentation/auth0/userinfo.json index 58f8d4b2..34f651d6 100644 --- a/docs/data/documentation/auth0/userinfo.json +++ b/docs/data/documentation/auth0/userinfo.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/userinfo"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"struct","roleHeading":"Structure","title":"UserInfo","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"externalID":"s:5Auth08UserInfoV"},"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}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","abstract":[{"text":"The last name of the user.","type":"text"}],"type":"topic","title":"familyName","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/familyname","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"familyName"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/profile","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"profile","abstract":[{"type":"text","text":"The URL of the user’s profile page."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"text":"The date and time the user’s information was last updated.","type":"text"}],"title":"updatedAt","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/updatedat"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/JSONObjectPayload-Implementations":{"role":"collectionGroup","kind":"article","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations","url":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","title":"JSONObjectPayload Implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"title":"preferredUsername","url":"\/documentation\/auth0\/userinfo\/preferredusername","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"preferredUsername","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","kind":"symbol","role":"symbol","abstract":[{"text":"The preferred username of the user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"type":"topic","abstract":[{"text":"The URL of the user’s picture.","type":"text"}],"title":"picture","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/picture","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"title":"website","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"website","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","abstract":[{"type":"text","text":"The URL of the user’s website."}],"url":"\/documentation\/auth0\/userinfo\/website"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"role":"symbol","type":"topic","title":"email","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","abstract":[{"text":"The email of the user.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/userinfo\/email"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"name","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","abstract":[{"type":"text","text":"The name of the user."}],"url":"\/documentation\/auth0\/userinfo\/name","title":"name"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"title":"customClaims","url":"\/documentation\/auth0\/userinfo\/customclaims","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"customClaims","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","type":"topic","abstract":[{"type":"text","text":"Any custom claims."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"abstract":[{"type":"text","text":"The first name of the user."}],"url":"\/documentation\/auth0\/userinfo\/givenname","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","role":"symbol","type":"topic","title":"givenName","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"title":"publicClaims","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","type":"topic","role":"symbol","abstract":[{"type":"text","text":"The list of public claims."}],"url":"\/documentation\/auth0\/userinfo\/publicclaims","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicClaims"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","url":"\/documentation\/auth0\/userinfo\/phonenumber","type":"topic","abstract":[{"type":"text","text":"The phone number of the user."}],"kind":"symbol","title":"phoneNumber"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"type":"topic","url":"\/documentation\/auth0\/userinfo\/middlename","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","abstract":[{"type":"text","text":"The middle name of the user."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"middleName","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"title":"address","url":"\/documentation\/auth0\/userinfo\/address","abstract":[{"type":"text","text":"The address of the user."}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]?","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sub","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","abstract":[{"type":"text","text":"The Auth0 user identifier."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","title":"sub","type":"topic","url":"\/documentation\/auth0\/userinfo\/sub"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"nickname"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","abstract":[{"type":"text","text":"The nickname of the user."}],"url":"\/documentation\/auth0\/userinfo\/nickname","title":"nickname"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"abstract":[{"type":"text","text":"The birthdate of the user."}],"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"birthdate"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","kind":"symbol","role":"symbol","title":"birthdate","url":"\/documentation\/auth0\/userinfo\/birthdate"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-token-claims":{"titleInlineContent":[{"text":"Claims","type":"text"}],"title":"Claims","identifier":"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","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"title":"phoneNumberVerified","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/phonenumberverified","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"If the user’s phone number is verified."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"gender"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/userinfo\/gender","title":"gender","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The gender of the user."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"locale"},{"kind":"text","text":": "},{"text":"Locale","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","abstract":[{"text":"The locale of the user.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/locale","title":"locale"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"abstract":[{"text":"The time zone of the user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"zoneinfo"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation8TimeZoneV","text":"TimeZone","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"zoneinfo","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/zoneinfo","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","abstract":[{"text":"If the user’s email is verified.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/emailverified","title":"emailVerified"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserInfo"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","externalID":"s:5Auth08UserInfoV","roleHeading":"Structure"},"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"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims"],"title":"Type Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"],"generated":true,"title":"Default Implementations"}],"kind":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/userinfo"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"name","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"kind":"symbol","abstract":[{"text":"The name of the user.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/name","title":"name","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","abstract":[{"text":"The phone number of the user.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/phonenumber","title":"phoneNumber","role":"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","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims","type":"link","titleInlineContent":[{"type":"text","text":"Claims"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"abstract":[{"type":"text","text":"The list of public claims."}],"kind":"symbol","title":"publicClaims","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/userinfo\/publicclaims"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","abstract":[{"text":"The email of the user.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/email","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"email"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"title":"profile","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","role":"symbol","abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"profile","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/profile","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"phoneNumberVerified","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}],"title":"phoneNumberVerified","abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/phonenumberverified","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/gender","abstract":[{"type":"text","text":"The gender of the user."}],"title":"gender","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"abstract":[{"type":"text","text":"The address of the user."}],"title":"address","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/address","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"customClaims"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?"}],"title":"customClaims","abstract":[{"type":"text","text":"Any custom claims."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/customclaims","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"nickname"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The nickname of the user."}],"title":"nickname","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/nickname","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"url":"\/documentation\/auth0\/userinfo\/middlename","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","title":"middleName","abstract":[{"type":"text","text":"The middle name of the user."}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"givenName","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"givenName","abstract":[{"type":"text","text":"The first name of the user."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/givenname","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The URL of the user’s website."}],"title":"website","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/website","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"emailVerified"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/emailverified","type":"topic","title":"emailVerified","role":"symbol","abstract":[{"type":"text","text":"If the user’s email is verified."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"url":"\/documentation\/auth0\/userinfo\/sub","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"sub","abstract":[{"type":"text","text":"The Auth0 user identifier."}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"locale","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Locale","preciseIdentifier":"s:10Foundation6LocaleV"},{"kind":"text","text":"?"}],"title":"locale","abstract":[{"type":"text","text":"The locale of the user."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/locale","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredUsername"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The preferred username of the user."}],"title":"preferredUsername","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/preferredusername","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"zoneinfo","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"TimeZone","preciseIdentifier":"s:10Foundation8TimeZoneV"},{"kind":"text","text":"?"}],"title":"zoneinfo","abstract":[{"type":"text","text":"The time zone of the user."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/zoneinfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo\/birthdate","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"birthdate","abstract":[{"text":"The birthdate of the user.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/JSONObjectPayload-Implementations":{"role":"collectionGroup","abstract":[],"title":"JSONObjectPayload Implementations","kind":"article","url":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"familyName","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/familyname","kind":"symbol","title":"familyName","role":"symbol","abstract":[{"text":"The last name of the user.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"title":"picture","abstract":[{"type":"text","text":"The URL of the user’s picture."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/picture","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"updatedAt","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The date and time the user’s information was last updated."}],"title":"updatedAt","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/updatedat","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt"}}} \ 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 2752ea64..6a7f9d99 100644 --- a/docs/data/documentation/auth0/userinfo/address.json +++ b/docs/data/documentation/auth0/userinfo/address.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/address"]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"title":"address","modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","externalID":"s:5Auth08UserInfoV7addressSDyS2SGSgvp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"address","kind":"identifier"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"]?"}],"roleHeading":"Instance Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"abstract":[{"type":"text","text":"The address of the user."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"address","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"address","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"name":"Requires"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"title":"address","url":"\/documentation\/auth0\/userinfo\/address","abstract":[{"type":"text","text":"The address of the user."}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]?","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address"}}} \ No newline at end of file +{"abstract":[{"text":"The address of the user.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"address","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"address"},{"type":"text","text":" scope."}],"type":"paragraph"}],"name":"Requires","type":"aside","style":"note"}],"kind":"content"}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/address"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","role":"symbol","roleHeading":"Instance Property","title":"address","externalID":"s:5Auth08UserInfoV7addressSDyS2SGSgvp","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"address","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"modules":[{"name":"Auth0"}]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"abstract":[{"type":"text","text":"The address of the user."}],"title":"address","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/address","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address"}}} \ 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 8bb71a14..4e108ea9 100644 --- a/docs/data/documentation/auth0/userinfo/birthdate.json +++ b/docs/data/documentation/auth0/userinfo/birthdate.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"name":"Requires","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"sections":[],"metadata":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth08UserInfoV9birthdateSSSgvp","roleHeading":"Instance Property","title":"birthdate"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"type":"text","text":"The birthdate of the user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/birthdate"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate"},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"abstract":[{"type":"text","text":"The birthdate of the user."}],"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"birthdate"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","kind":"symbol","role":"symbol","title":"birthdate","url":"\/documentation\/auth0\/userinfo\/birthdate"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"role":"symbol","symbolKind":"property","title":"birthdate","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV9birthdateSSSgvp","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"birthdate","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/birthdate"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"name":"Requires","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside"}]}],"abstract":[{"text":"The birthdate of the user.","type":"text"}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo\/birthdate","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"birthdate","abstract":[{"text":"The birthdate of the user.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ 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 d7236cbd..74d8190b 100644 --- a/docs/data/documentation/auth0/userinfo/customclaims.json +++ b/docs/data/documentation/auth0/userinfo/customclaims.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"]]},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"customClaims"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}]}],"kind":"declarations"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/customclaims"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Any custom claims."}],"metadata":{"modules":[{"name":"Auth0"}],"title":"customClaims","externalID":"s:5Auth08UserInfoV12customClaimsSDySSypGSgvp","role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"customClaims","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"title":"customClaims","url":"\/documentation\/auth0\/userinfo\/customclaims","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"customClaims","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","type":"topic","abstract":[{"type":"text","text":"Any custom claims."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/customclaims"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"Any custom claims."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV12customClaimsSDySSypGSgvp","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"customClaims"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"role":"symbol","title":"customClaims"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"customClaims"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?"}],"title":"customClaims","abstract":[{"type":"text","text":"Any custom claims."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/customclaims","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 7cb734d8..7d2b63f8 100644 --- a/docs/data/documentation/auth0/userinfo/email.json +++ b/docs/data/documentation/auth0/userinfo/email.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The email of the user."}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"email"},{"type":"text","text":" scope."}]}],"style":"note"}]}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"title":"email","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV5emailSSSgvp","role":"symbol","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/email"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"role":"symbol","type":"topic","title":"email","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","abstract":[{"text":"The email of the user.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/userinfo\/email"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV5emailSSSgvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"email"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"The email of the user."}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/email"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"style":"note","type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"email","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","abstract":[{"text":"The email of the user.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/email","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"email"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 18d2ca26..21c198f7 100644 --- a/docs/data/documentation/auth0/userinfo/emailverified.json +++ b/docs/data/documentation/auth0/userinfo/emailverified.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified"},"sections":[],"kind":"symbol","abstract":[{"text":"If the user’s email is verified.","type":"text"}],"metadata":{"roleHeading":"Instance Property","role":"symbol","title":"emailVerified","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}],"symbolKind":"property","externalID":"s:5Auth08UserInfoV13emailVerifiedSbSgvp","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"email"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/emailverified"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","abstract":[{"text":"If the user’s email is verified.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/emailverified","title":"emailVerified"}}} \ No newline at end of file +{"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/userinfo\/emailverified"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"If the user’s email is verified."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"email","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}],"name":"Requires","style":"note"}]}],"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV13emailVerifiedSbSgvp","modules":[{"name":"Auth0"}],"title":"emailVerified","role":"symbol","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"emailVerified"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/emailverified","type":"topic","title":"emailVerified","role":"symbol","abstract":[{"type":"text","text":"If the user’s email is verified."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ 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 05552a34..39a9f0c2 100644 --- a/docs/data/documentation/auth0/userinfo/familyname.json +++ b/docs/data/documentation/auth0/userinfo/familyname.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"familyName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"familyName","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth08UserInfoV10familyNameSSSgvp"},"abstract":[{"type":"text","text":"The last name of the user."}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"familyName"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}]}],"style":"note","type":"aside"}],"kind":"content"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/userinfo\/familyname"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","abstract":[{"text":"The last name of the user.","type":"text"}],"type":"topic","title":"familyName","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/familyname","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"familyName"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV10familyNameSSSgvp","role":"symbol","roleHeading":"Instance Property","title":"familyName","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"familyName"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"familyName"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note","type":"aside","name":"Requires"}],"kind":"content"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/userinfo\/familyname"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"The last name of the user.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"familyName","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/familyname","kind":"symbol","title":"familyName","role":"symbol","abstract":[{"text":"The last name of the user.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 5538913e..c462548d 100644 --- a/docs/data/documentation/auth0/userinfo/gender.json +++ b/docs/data/documentation/auth0/userinfo/gender.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"]}]},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"type":"aside","name":"Requires"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/gender"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The gender of the user."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","interfaceLanguage":"swift"},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"gender","externalID":"s:5Auth08UserInfoV6genderSSSgvp","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"gender"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"gender"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/userinfo\/gender","title":"gender","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The gender of the user."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"symbolKind":"property","role":"symbol","title":"gender","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","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":"?"}],"externalID":"s:5Auth08UserInfoV6genderSSSgvp"},"abstract":[{"text":"The gender of the user.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/gender"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"gender","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/gender","abstract":[{"type":"text","text":"The gender of the user."}],"title":"gender","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ 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 4e58728f..ddd77094 100644 --- a/docs/data/documentation/auth0/userinfo/givenname.json +++ b/docs/data/documentation/auth0/userinfo/givenname.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/givenname"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"givenName","externalID":"s:5Auth08UserInfoV9givenNameSSSgvp","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","role":"symbol"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"givenName"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"The first name of the user.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"abstract":[{"type":"text","text":"The first name of the user."}],"url":"\/documentation\/auth0\/userinfo\/givenname","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","role":"symbol","type":"topic","title":"givenName","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"title":"Auth0","kind":"symbol","type":"topic","url":"\/documentation\/auth0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","type":"topic","kind":"symbol","title":"UserInfo","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"name":"Requires","type":"aside","style":"note"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/givenname"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"abstract":[{"text":"The first name of the user.","type":"text"}],"metadata":{"role":"symbol","title":"givenName","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV9givenNameSSSgvp","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"givenName","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"givenName","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"givenName","abstract":[{"type":"text","text":"The first name of the user."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/givenname","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"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 a5590a09..81199bf2 100644 --- a/docs/data/documentation/auth0/userinfo/init(json:).json +++ b/docs/data/documentation/auth0/userinfo/init(json:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"json"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"languages":["swift"]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/init(json:)"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV4jsonACSgSDySSypG_tcfc","roleHeading":"Initializer","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"text":"json","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"symbolKind":"init","title":"init(json:)","extendedModule":"Auth0"},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"UserInfo"},{"type":"text","text":" from a JSON dictionary."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"text":"json","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"kind":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserInfo"},{"text":" from a JSON dictionary.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/init(json:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","title":"init(json:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/JSONObjectPayload-Implementations":{"role":"collectionGroup","kind":"article","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations","url":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","title":"JSONObjectPayload Implementations","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"]]},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"text":"json","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/init(json:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"init","role":"symbol","externalID":"s:5Auth08UserInfoV4jsonACSgSDySSypG_tcfc","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"json"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"title":"init(json:)"},"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"UserInfo"},{"text":" from a JSON dictionary.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/JSONObjectPayload-Implementations":{"role":"collectionGroup","abstract":[],"title":"JSONObjectPayload Implementations","kind":"article","url":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"json"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/init(json:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"UserInfo","type":"codeVoice"},{"type":"text","text":" from a JSON dictionary."}],"role":"symbol","title":"init(json:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 3b35e42b..16ea01ed 100644 --- a/docs/data/documentation/auth0/userinfo/jsonobjectpayload-implementations.json +++ b/docs/data/documentation/auth0/userinfo/jsonobjectpayload-implementations.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"title":"JSONObjectPayload Implementations","roleHeading":"API Collection"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"},"kind":"article","sections":[],"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"text":"json","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"kind":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserInfo"},{"text":" from a JSON dictionary.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/init(json:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","title":"init(json:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"title":"JSONObjectPayload Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"],"generated":true}],"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"json"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/init(json:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"UserInfo","type":"codeVoice"},{"type":"text","text":" from a JSON dictionary."}],"role":"symbol","title":"init(json:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ 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 e1968680..c175e77b 100644 --- a/docs/data/documentation/auth0/userinfo/locale.json +++ b/docs/data/documentation/auth0/userinfo/locale.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/locale"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"locale","kind":"identifier"},{"kind":"text","text":": "},{"text":"Locale","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}],"role":"symbol","title":"locale","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV6locale10Foundation6LocaleVSgvp"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"The locale of the user."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"locale"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Locale","preciseIdentifier":"s:10Foundation6LocaleV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}]}],"type":"aside"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"locale"},{"kind":"text","text":": "},{"text":"Locale","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","abstract":[{"text":"The locale of the user.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/locale","title":"locale"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"type":"text","text":"The locale of the user."}],"sections":[],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/locale"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"locale"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV","text":"Locale"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]},{"content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"style":"note","type":"aside"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth08UserInfoV6locale10Foundation6LocaleVSgvp","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"locale"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation6LocaleV","text":"Locale","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","title":"locale","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"locale","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Locale","preciseIdentifier":"s:10Foundation6LocaleV"},{"kind":"text","text":"?"}],"title":"locale","abstract":[{"type":"text","text":"The locale of the user."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/locale","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"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 f10d4fbd..bdebc399 100644 --- a/docs/data/documentation/auth0/userinfo/middlename.json +++ b/docs/data/documentation/auth0/userinfo/middlename.json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName"},"metadata":{"externalID":"s:5Auth08UserInfoV10middleNameSSSgvp","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"title":"middleName","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"name":"Requires","type":"aside"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/middlename"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"kind":"symbol","abstract":[{"text":"The middle name of the user.","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"type":"topic","url":"\/documentation\/auth0\/userinfo\/middlename","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","abstract":[{"type":"text","text":"The middle name of the user."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"middleName","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"name":"Requires","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}]}]}],"kind":"symbol","metadata":{"title":"middleName","externalID":"s:5Auth08UserInfoV10middleNameSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/middlename"]}],"sections":[],"schemaVersion":{"major":0,"patch":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\/middleName","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The middle name of the user."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"url":"\/documentation\/auth0\/userinfo","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"url":"\/documentation\/auth0\/userinfo\/middlename","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","title":"middleName","abstract":[{"type":"text","text":"The middle name of the user."}],"kind":"symbol","role":"symbol"}}} \ 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 fff93b6c..8e5cfe09 100644 --- a/docs/data/documentation/auth0/userinfo/name.json +++ b/docs/data/documentation/auth0/userinfo/name.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"name","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","externalID":"s:5Auth08UserInfoV4nameSSSgvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"name"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"name"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"style":"note","name":"Requires"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"abstract":[{"text":"The name of the user.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/name"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"name","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","abstract":[{"type":"text","text":"The name of the user."}],"url":"\/documentation\/auth0\/userinfo\/name","title":"name"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"The name of the user."}],"kind":"symbol","sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"property","title":"name","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV4nameSSSgvp"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/name"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}]}],"name":"Requires","style":"note"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"name","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"kind":"symbol","abstract":[{"text":"The name of the user.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/name","title":"name","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"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 37cc79ea..1f423ba4 100644 --- a/docs/data/documentation/auth0/userinfo/nickname.json +++ b/docs/data/documentation/auth0/userinfo/nickname.json @@ -1 +1 @@ -{"abstract":[{"text":"The nickname of the user.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"nickname"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}]}],"type":"aside"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/nickname"]}],"sections":[],"metadata":{"externalID":"s:5Auth08UserInfoV8nicknameSSSgvp","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"nickname","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"nickname"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"nickname"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","abstract":[{"type":"text","text":"The nickname of the user."}],"url":"\/documentation\/auth0\/userinfo\/nickname","title":"nickname"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/userinfo\/nickname"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth08UserInfoV8nicknameSSSgvp","roleHeading":"Instance Property","role":"symbol","title":"nickname","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"abstract":[{"type":"text","text":"The nickname of the user."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"nickname"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"type":"aside"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"nickname"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The nickname of the user."}],"title":"nickname","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/nickname","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname"}}} \ 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 b0ca4faa..ccc280ad 100644 --- a/docs/data/documentation/auth0/userinfo/phonenumber.json +++ b/docs/data/documentation/auth0/userinfo/phonenumber.json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneNumber","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"style":"note","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"phone_number","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside"}]}],"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"symbolKind":"property","externalID":"s:5Auth08UserInfoV11phoneNumberSSSgvp","title":"phoneNumber","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"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\/phoneNumber","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/phonenumber"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"The phone number of the user.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","url":"\/documentation\/auth0\/userinfo\/phonenumber","type":"topic","abstract":[{"type":"text","text":"The phone number of the user."}],"kind":"symbol","title":"phoneNumber"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file +{"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","externalID":"s:5Auth08UserInfoV11phoneNumberSSSgvp","roleHeading":"Instance Property","title":"phoneNumber","modules":[{"name":"Auth0"}],"symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"phone_number"},{"type":"text","text":" scope."}]}],"style":"note"}]}],"abstract":[{"type":"text","text":"The phone number of the user."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/phonenumber"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","abstract":[{"text":"The phone number of the user.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/phonenumber","title":"phoneNumber","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ 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 143553e6..0c4c7fde 100644 --- a/docs/data/documentation/auth0/userinfo/phonenumberverified.json +++ b/docs/data/documentation/auth0/userinfo/phonenumberverified.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"title":"phoneNumberVerified","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneNumberVerified","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV19phoneNumberVerifiedSbSgvp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"phone_number","type":"codeVoice"},{"type":"text","text":" scope."}]}],"style":"note","name":"Requires","type":"aside"}]}],"abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/phonenumberverified"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"title":"phoneNumberVerified","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/phonenumberverified","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"If the user’s phone number is verified."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneNumberVerified"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"phoneNumberVerified","externalID":"s:5Auth08UserInfoV19phoneNumberVerifiedSbSgvp","roleHeading":"Instance Property"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"If the user’s phone number is verified.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/phonenumberverified"]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"phone_number"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note","type":"aside"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"phoneNumberVerified","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}],"title":"phoneNumberVerified","abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/phonenumberverified","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ 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 fd10e6b1..7f945203 100644 --- a/docs/data/documentation/auth0/userinfo/picture.json +++ b/docs/data/documentation/auth0/userinfo/picture.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"kind":"text","text":": "},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}]}],"name":"Requires","type":"aside"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/picture"]}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"picture","kind":"identifier"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV7picture10Foundation3URLVSgvp","roleHeading":"Instance Property","title":"picture","modules":[{"name":"Auth0"}],"symbolKind":"property"},"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 picture."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"type":"topic","abstract":[{"text":"The URL of the user’s picture.","type":"text"}],"title":"picture","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/picture","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture"}}} \ No newline at end of file +{"sections":[],"metadata":{"title":"picture","symbolKind":"property","externalID":"s:5Auth08UserInfoV7picture10Foundation3URLVSgvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"picture","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The URL of the user’s picture."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"picture"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"style":"note","name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/picture"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"title":"picture","abstract":[{"type":"text","text":"The URL of the user’s picture."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/picture","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 14060619..2e931ed7 100644 --- a/docs/data/documentation/auth0/userinfo/preferredusername.json +++ b/docs/data/documentation/auth0/userinfo/preferredusername.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/preferredusername"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"preferredUsername","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"style":"note","type":"aside"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername"},"sections":[],"metadata":{"externalID":"s:5Auth08UserInfoV17preferredUsernameSSSgvp","role":"symbol","roleHeading":"Instance Property","title":"preferredUsername","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"preferredUsername"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"text":"The preferred username of the user.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"title":"preferredUsername","url":"\/documentation\/auth0\/userinfo\/preferredusername","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"preferredUsername","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","kind":"symbol","role":"symbol","abstract":[{"text":"The preferred username of the user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"type":"text","text":"The preferred username of the user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/preferredusername"]}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth08UserInfoV17preferredUsernameSSSgvp","title":"preferredUsername","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"preferredUsername","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"preferredUsername","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}]}],"style":"note"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredUsername"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The preferred username of the user."}],"title":"preferredUsername","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/preferredusername","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername"}}} \ 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 fde28e9f..465bd87b 100644 --- a/docs/data/documentation/auth0/userinfo/profile.json +++ b/docs/data/documentation/auth0/userinfo/profile.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV7profile10Foundation3URLVSgvp","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"profile"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"title":"profile","symbolKind":"property","role":"symbol","roleHeading":"Instance Property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}]}]},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"style":"note","type":"aside","name":"Requires"}],"kind":"content"}],"kind":"symbol","abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/profile"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/profile","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"profile","abstract":[{"type":"text","text":"The URL of the user’s profile page."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"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 profile page."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"profile"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]},{"content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}]}],"style":"note"}],"kind":"content"}],"metadata":{"symbolKind":"property","title":"profile","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV7profile10Foundation3URLVSgvp"},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/profile"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"title":"profile","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","role":"symbol","abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"profile","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/profile","type":"topic"}}} \ 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 82dd2460..8c7ee296 100644 --- a/docs/data/documentation/auth0/userinfo/publicclaims.json +++ b/docs/data/documentation/auth0/userinfo/publicclaims.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/publicclaims"]}],"metadata":{"symbolKind":"property","title":"publicClaims","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"publicClaims"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]"}],"externalID":"s:5Auth08UserInfoV12publicClaimsSaySSGvpZ"},"abstract":[{"type":"text","text":"The list of public claims."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"title":"publicClaims","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","type":"topic","role":"symbol","abstract":[{"type":"text","text":"The list of public claims."}],"url":"\/documentation\/auth0\/userinfo\/publicclaims","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicClaims"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"roleHeading":"Type Property","symbolKind":"property","title":"publicClaims","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV12publicClaimsSaySSGvpZ","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"publicClaims"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]","kind":"text"}],"role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/publicclaims"]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The list of public claims."}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]","kind":"text"}],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"abstract":[{"type":"text","text":"The list of public claims."}],"kind":"symbol","title":"publicClaims","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/userinfo\/publicclaims"}}} \ 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 2d5cec97..d1f84fc7 100644 --- a/docs/data/documentation/auth0/userinfo/sub.json +++ b/docs/data/documentation/auth0/userinfo/sub.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth08UserInfoV3subSSvp","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"sub"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/sub"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"The Auth0 user identifier."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sub","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","abstract":[{"type":"text","text":"The Auth0 user identifier."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","title":"sub","type":"topic","url":"\/documentation\/auth0\/userinfo\/sub"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"sub","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]}]}],"sections":[],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"sub","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"sub"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"role":"symbol","externalID":"s:5Auth08UserInfoV3subSSvp","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"The Auth0 user identifier."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/sub"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"url":"\/documentation\/auth0\/userinfo\/sub","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"sub","abstract":[{"type":"text","text":"The Auth0 user identifier."}],"kind":"symbol","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 2e21e4ef..bf6ca8b4 100644 --- a/docs/data/documentation/auth0/userinfo/updatedat.json +++ b/docs/data/documentation/auth0/userinfo/updatedat.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"title":"updatedAt","role":"symbol","externalID":"s:5Auth08UserInfoV9updatedAt10Foundation4DateVSgvp","roleHeading":"Instance Property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note","type":"aside"}]}],"kind":"symbol","abstract":[{"text":"The date and time the user’s information was last updated.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/updatedat"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"text":"The date and time the user’s information was last updated.","type":"text"}],"title":"updatedAt","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/updatedat"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/updatedat"]}],"sections":[],"metadata":{"title":"updatedAt","symbolKind":"property","externalID":"s:5Auth08UserInfoV9updatedAt10Foundation4DateVSgvp","role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"updatedAt","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The date and time the user’s information was last updated."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"text":"?","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"name":"Requires","style":"note","type":"aside"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"updatedAt","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The date and time the user’s information was last updated."}],"title":"updatedAt","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/updatedat","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt"}}} \ 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 b168033a..faab944f 100644 --- a/docs/data/documentation/auth0/userinfo/website.json +++ b/docs/data/documentation/auth0/userinfo/website.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"website","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"languages":["swift"]}]},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note"}],"kind":"content"}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth08UserInfoV7website10Foundation3URLVSgvp","role":"symbol","modules":[{"name":"Auth0"}],"title":"website","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"website"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"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."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/website"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"title":"website","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"website","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","abstract":[{"type":"text","text":"The URL of the user’s website."}],"url":"\/documentation\/auth0\/userinfo\/website"}}} \ No newline at end of file +{"kind":"symbol","metadata":{"externalID":"s:5Auth08UserInfoV7website10Foundation3URLVSgvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","title":"website","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"website","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":"?","kind":"text"}],"role":"symbol"},"abstract":[{"text":"The URL of the user’s website.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/website"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"website","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The URL of the user’s website."}],"title":"website","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/website","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ 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 6c6e3da8..7e96ca4b 100644 --- a/docs/data/documentation/auth0/userinfo/zoneinfo.json +++ b/docs/data/documentation/auth0/userinfo/zoneinfo.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"zoneinfo","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation8TimeZoneV","text":"TimeZone"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside","name":"Requires"}]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"zoneinfo","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation8TimeZoneV","text":"TimeZone"},{"kind":"text","text":"?"}],"title":"zoneinfo","externalID":"s:5Auth08UserInfoV8zoneinfo10Foundation8TimeZoneVSgvp","symbolKind":"property","roleHeading":"Instance Property","role":"symbol"},"kind":"symbol","abstract":[{"text":"The time zone of the user.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/zoneinfo"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"abstract":[{"text":"The time zone of the user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"zoneinfo"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation8TimeZoneV","text":"TimeZone","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"zoneinfo","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/zoneinfo","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation8TimeZoneV","kind":"typeIdentifier","text":"TimeZone"},{"text":"?","kind":"text"}],"role":"symbol","externalID":"s:5Auth08UserInfoV8zoneinfo10Foundation8TimeZoneVSgvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"zoneinfo"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/zoneinfo"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo"},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"The time zone of the user."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"zoneinfo","kind":"identifier"},{"kind":"text","text":": "},{"text":"TimeZone","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation8TimeZoneV"},{"kind":"text","text":"?"}],"languages":["swift"]}]},{"content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"type":"aside","name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"zoneinfo","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"TimeZone","preciseIdentifier":"s:10Foundation8TimeZoneV"},{"kind":"text","text":"?"}],"title":"zoneinfo","abstract":[{"type":"text","text":"The time zone of the user."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/zoneinfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes.json b/docs/data/documentation/auth0/userpatchattributes.json index e28fe410..41ae90e8 100644 --- a/docs/data/documentation/auth0/userpatchattributes.json +++ b/docs/data/documentation/auth0/userpatchattributes.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"final"},{"text":" ","kind":"text"},{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"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","type":"reference","isActive":true},{"text":".","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"symbolKind":"class","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"externalID":"s:5Auth019UserPatchAttributesC","roleHeading":"Class","modules":[{"name":"Auth0"}],"title":"UserPatchAttributes","role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"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":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"deprecated":true,"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Set the verified status of the email."}],"title":"emailVerified(_:connection:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"emailVerified","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"type":"topic","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"deprecated":true,"abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","title":"blocked(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"deprecated":true,"abstract":[{"type":"text","text":"Change the username."}],"url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","type":"topic","title":"username(_:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"phoneNumber","kind":"identifier"},{"kind":"text","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"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"phoneNumber(_:verified:verify:connection:clientId:)","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","kind":"symbol","role":"symbol","abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"abstract":[{"type":"text","text":"Update user metadata."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userMetadata","kind":"identifier"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"type":"topic","title":"userMetadata(_:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"deprecated":true,"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Change the user’s password."}],"title":"password(_:verify:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","type":"topic","kind":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance.","type":"text"}],"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"dictionary"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"title":"init(dictionary:)","role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)"},"https://auth0.com/docs/api/management/v2":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","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/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","deprecated":true,"abstract":[{"type":"text","text":"Change the email of the user."}],"role":"symbol","title":"email(_:verified:verify:connection:clientId:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"abstract":[{"text":"Update app metadata.","type":"text"}],"title":"appMetadata(_:)","type":"topic","role":"symbol","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"appMetadata"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","title":"phoneVerified(_:connection:)","fragments":[{"kind":"keyword","text":"func"},{"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"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"deprecated":true,"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","role":"symbol","type":"topic","abstract":[{"text":"Set the verified status of the phone number.","type":"text"}]}}} \ No newline at end of file +{"sections":[],"metadata":{"title":"UserPatchAttributes","roleHeading":"Class","externalID":"s:5Auth019UserPatchAttributesC","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"symbolKind":"class","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes"],"traits":[{"interfaceLanguage":"swift"}]}],"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:)"]}],"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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},{"text":".","type":"text"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"final"},{"text":" ","kind":"text"},{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"title":"appMetadata(_:)","type":"topic","deprecated":true,"abstract":[{"type":"text","text":"Update app metadata."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"appMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"title":"userMetadata(_:)","url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Update user metadata."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userMetadata"},{"kind":"text","text":"(["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","title":"blocked(_:)","deprecated":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"role":"symbol","abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)"},"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"}],"url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","title":"phoneNumber(_:verified:verify:connection:clientId:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)"},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","title":"Management API v2","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","deprecated":true,"title":"emailVerified(_:connection:)","type":"topic","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","abstract":[{"text":"Set the verified status of the email.","type":"text"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneVerified"},{"kind":"text","text":"("},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","abstract":[{"text":"Set the verified status of the phone number.","type":"text"}],"title":"phoneVerified(_:connection:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"title":"password(_:verify:connection:)","abstract":[{"type":"text","text":"Change the user’s password."}],"deprecated":true,"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"password"},{"kind":"text","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":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"type":"topic","url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","role":"symbol","deprecated":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"username"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"username(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","abstract":[{"text":"Change the username.","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"kind":"symbol","role":"symbol","abstract":[{"text":"Change the email of the user.","type":"text"}],"deprecated":true,"title":"email(_:verified:verify:connection:clientId:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"title":"init(dictionary:)","type":"topic","abstract":[{"type":"text","text":"Creates a new "},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance.","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"dictionary"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"}}} \ 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 1f617c5b..e50b1532 100644 --- a/docs/data/documentation/auth0/userpatchattributes/appmetadata(_:).json +++ b/docs/data/documentation/auth0/userpatchattributes/appmetadata(_:).json @@ -1 +1 @@ -{"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"platforms":[],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"appMetadata"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"externalID":"s:5Auth019UserPatchAttributesC11appMetadatayACSDySSypGF","roleHeading":"Instance Method","title":"appMetadata(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"appMetadata","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"metadata"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","text":"UserPatchAttributes"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New app metadata values."}]}],"name":"metadata"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"abstract":[{"text":"Update app metadata.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"abstract":[{"text":"Update app metadata.","type":"text"}],"title":"appMetadata(_:)","type":"topic","role":"symbol","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"appMetadata"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"appMetadata"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"metadata","kind":"internalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"New app metadata values."}],"type":"paragraph"}],"name":"metadata"}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","type":"heading","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"}],"sections":[],"metadata":{"externalID":"s:5Auth019UserPatchAttributesC11appMetadatayACSDySSypGF","modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"appMetadata","kind":"identifier"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"platforms":[],"title":"appMetadata(_:)","role":"symbol","roleHeading":"Instance Method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)"},"abstract":[{"type":"text","text":"Update app metadata."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"title":"appMetadata(_:)","type":"topic","deprecated":true,"abstract":[{"type":"text","text":"Update app metadata."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"appMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"}}} \ 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 74e58605..a5356adb 100644 --- a/docs/data/documentation/auth0/userpatchattributes/blocked(_:).json +++ b/docs/data/documentation/auth0/userpatchattributes/blocked(_:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)"},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"blocked"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","platforms":[],"externalID":"s:5Auth019UserPatchAttributesC7blockedyACSbF","roleHeading":"Instance Method","title":"blocked(_:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"blocked"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}]}]},{"parameters":[{"name":"blocked","content":[{"inlineContent":[{"text":"If the user is blocked.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"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\/blocked(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"deprecated":true,"abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","title":"blocked(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"blocked"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"blocked"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"blocked","content":[{"inlineContent":[{"type":"text","text":"If the user is blocked."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"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"}],"metadata":{"platforms":[],"title":"blocked(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"blocked"},{"text":"(","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth019UserPatchAttributesC7blockedyACSbF","symbolKind":"method"},"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/blocked(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","title":"blocked(_:)","deprecated":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"role":"symbol","abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)"}}} \ 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 d39c4cad..9218ba6f 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 @@ -{"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"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"email","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"text":"New email for the user.","type":"text"}]}]},{"name":"verified","content":[{"type":"paragraph","inlineContent":[{"text":"If the email is verified.","type":"text"}]}]},{"name":"verify","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the user should verify the email."}]}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}]},{"name":"clientId","content":[{"inlineContent":[{"text":"Auth0 Client ID.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"text":"Return Value","level":2,"type":"heading","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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)"]}],"metadata":{"externalID":"s:5Auth019UserPatchAttributesC5email_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","modules":[{"name":"Auth0"}],"role":"symbol","title":"email(_:verified:verify:connection:clientId:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"platforms":[],"symbolKind":"method"},"abstract":[{"type":"text","text":"Change the email of the user."}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","deprecated":true,"abstract":[{"type":"text","text":"Change the email of the user."}],"role":"symbol","title":"email(_:verified:verify:connection:clientId:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"email"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":"? = nil, "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"New email for the user."}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"text":"If the email is verified.","type":"text"}],"type":"paragraph"}],"name":"verified"},{"name":"verify","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the user should verify the email."}]}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Auth0 Client ID."}],"type":"paragraph"}],"name":"clientId"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"metadata":{"role":"symbol","title":"email(_:verified:verify:connection:clientId:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"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"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"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"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","platforms":[],"externalID":"s:5Auth019UserPatchAttributesC5email_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","symbolKind":"method"},"abstract":[{"type":"text","text":"Change the email of the user."}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"kind":"symbol","role":"symbol","abstract":[{"text":"Change the email of the user.","type":"text"}],"deprecated":true,"title":"email(_:verified:verify:connection:clientId:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 ad350034..eeb10cc5 100644 --- a/docs/data/documentation/auth0/userpatchattributes/emailverified(_:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/emailverified(_:connection:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"text":"Set the verified status of the email.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"emailVerified(_:connection:)","symbolKind":"method","externalID":"s:5Auth019UserPatchAttributesC13emailVerified_10connectionACSb_SStF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"role":"symbol","platforms":[]},"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"verified","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"If the email is verified."}],"type":"paragraph"}],"name":"verified"},{"name":"connection","content":[{"inlineContent":[{"text":"Name of the connection.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"deprecated":true,"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Set the verified status of the email."}],"title":"emailVerified(_:connection:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"emailVerified","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"type":"topic","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]}}} \ No newline at end of file +{"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"declarations":[{"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"},{"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\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"If the email is verified.","type":"text"}]}],"name":"verified"},{"content":[{"inlineContent":[{"text":"Name of the connection.","type":"text"}],"type":"paragraph"}],"name":"connection"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"sections":[],"metadata":{"role":"symbol","title":"emailVerified(_:connection:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC13emailVerified_10connectionACSb_SStF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"roleHeading":"Instance Method","platforms":[]},"abstract":[{"type":"text","text":"Set the verified status of the email."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","deprecated":true,"title":"emailVerified(_:connection:)","type":"topic","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","abstract":[{"text":"Set the verified status of the email.","type":"text"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"}}} \ 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 5e092eff..f4644eaa 100644 --- a/docs/data/documentation/auth0/userpatchattributes/init(dictionary:).json +++ b/docs/data/documentation/auth0/userpatchattributes/init(dictionary:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC10dictionaryACSDySSypG_tcfc","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"dictionary","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"title":"init(dictionary:)","symbolKind":"init","role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/init(dictionary:)"]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"dictionary","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:])"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Default attribute values.","type":"text"}],"type":"paragraph"}],"name":"dictionary"}]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","type":"topic","kind":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance.","type":"text"}],"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"dictionary"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"title":"init(dictionary:)","role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ 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"],"tokens":[{"text":"init","kind":"keyword"},{"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":"] = [:])"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"dictionary","content":[{"type":"paragraph","inlineContent":[{"text":"Default attribute values.","type":"text"}]}]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","interfaceLanguage":"swift"},"metadata":{"symbolKind":"init","externalID":"s:5Auth019UserPatchAttributesC10dictionaryACSDySSypG_tcfc","title":"init(dictionary:)","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"dictionary","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"role":"symbol"},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/init(dictionary:)"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"title":"init(dictionary:)","type":"topic","abstract":[{"type":"text","text":"Creates a new "},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance.","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"dictionary"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"}}} \ 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 2cd57491..5d2433cb 100644 --- a/docs/data/documentation/auth0/userpatchattributes/password(_:verify:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/password(_:verify:connection:).json @@ -1 +1 @@ -{"abstract":[{"text":"Change the user’s password.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"password","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"password","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"New password for the user.","type":"text"}],"type":"paragraph"}],"name":"password"},{"content":[{"inlineContent":[{"type":"text","text":"If the password should be verified by the user."}],"type":"paragraph"}],"name":"verify"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection.","type":"text"}]}],"name":"connection"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"metadata":{"symbolKind":"method","externalID":"s:5Auth019UserPatchAttributesC8password_6verify10connectionACSS_SbSgSStF","modules":[{"name":"Auth0"}],"title":"password(_:verify:connection:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"password"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"verify","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"role":"symbol","roleHeading":"Instance Method","platforms":[]},"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)"]}],"kind":"symbol","sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"deprecated":true,"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Change the user’s password."}],"title":"password(_:verify:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Change the user’s password."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"password"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"password"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"? = nil, "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}]}],"kind":"declarations"},{"kind":"parameters","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"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"metadata":{"title":"password(_:verify:connection:)","roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC8password_6verify10connectionACSS_SbSgSStF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"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"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"symbolKind":"method","modules":[{"name":"Auth0"}],"platforms":[]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"title":"password(_:verify:connection:)","abstract":[{"type":"text","text":"Change the user’s password."}],"deprecated":true,"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"password"},{"kind":"text","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":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}}} \ 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 73038f9c..5be92046 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 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"? = nil, "},{"text":"verify","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"New phone number for the user."}],"type":"paragraph"}],"name":"phoneNumber"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the phone number is verified."}]}],"name":"verified"},{"name":"verify","content":[{"inlineContent":[{"type":"text","text":"If the user should verify the phone number."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}],"name":"connection"},{"name":"clientId","content":[{"inlineContent":[{"type":"text","text":"Auth0 Client ID."}],"type":"paragraph"}]}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"metadata":{"title":"phoneNumber(_:verified:verify:connection:clientId:)","roleHeading":"Instance Method","platforms":[],"externalID":"s:5Auth019UserPatchAttributesC11phoneNumber_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","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","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"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\/phonenumber(_:verified:verify:connection:clientid:)"]}],"kind":"symbol","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:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"phoneNumber","kind":"identifier"},{"kind":"text","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"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"phoneNumber(_:verified:verify:connection:clientId:)","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","kind":"symbol","role":"symbol","abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"}}} \ No newline at end of file +{"abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"metadata":{"externalID":"s:5Auth019UserPatchAttributesC11phoneNumber_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"platforms":[],"title":"phoneNumber(_:verified:verify:connection:clientId:)","role":"symbol","roleHeading":"Instance Method"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":"? = nil, "},{"text":"verify","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"New phone number for the user."}],"type":"paragraph"}],"name":"phoneNumber"},{"content":[{"type":"paragraph","inlineContent":[{"text":"If the phone number is verified.","type":"text"}]}],"name":"verified"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the user should verify the phone number."}]}],"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"},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"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"}],"url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","title":"phoneNumber(_:verified:verify:connection:clientId:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 7d38cefa..43fdc077 100644 --- a/docs/data/documentation/auth0/userpatchattributes/phoneverified(_:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/phoneverified(_:connection:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Set the verified status of the phone number."}],"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneVerified"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"verified","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}]}]},{"parameters":[{"name":"verified","content":[{"inlineContent":[{"text":"If the phone number is verified or not.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"phoneVerified","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"roleHeading":"Instance Method","role":"symbol","symbolKind":"method","title":"phoneVerified(_:connection:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC13phoneVerified_10connectionACSb_SStF","platforms":[]},"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\/phoneverified(_:connection:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","title":"phoneVerified(_:connection:)","fragments":[{"kind":"keyword","text":"func"},{"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"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"deprecated":true,"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","role":"symbol","type":"topic","abstract":[{"text":"Set the verified status of the phone number.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"verified","kind":"internalParam"},{"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":") -> "},{"text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"If the phone number is verified or not."}],"type":"paragraph"}],"name":"verified"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"}]},{"content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"abstract":[{"text":"Set the verified status of the phone number.","type":"text"}],"metadata":{"role":"symbol","title":"phoneVerified(_:connection:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC13phoneVerified_10connectionACSb_SStF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneVerified"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"roleHeading":"Instance Method","platforms":[]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneVerified"},{"kind":"text","text":"("},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","abstract":[{"text":"Set the verified status of the phone number.","type":"text"}],"title":"phoneVerified(_:connection:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"}}} \ 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 fe998c78..a082e7a7 100644 --- a/docs/data/documentation/auth0/userpatchattributes/usermetadata(_:).json +++ b/docs/data/documentation/auth0/userpatchattributes/usermetadata(_:).json @@ -1 +1 @@ -{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userMetadata"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC12userMetadatayACSDySSypGF","role":"symbol","title":"userMetadata(_:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"kind":"symbol","abstract":[{"type":"text","text":"Update user metadata."}],"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userMetadata"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"metadata","kind":"internalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"New user metadata values.","type":"text"}],"type":"paragraph"}],"name":"metadata"}],"kind":"parameters"},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"abstract":[{"type":"text","text":"Update user metadata."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userMetadata","kind":"identifier"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"type":"topic","title":"userMetadata(_:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"}}} \ No newline at end of file +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Update user metadata.","type":"text"}],"metadata":{"title":"userMetadata(_:)","symbolKind":"method","roleHeading":"Instance Method","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC12userMetadatayACSDySSypGF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userMetadata"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userMetadata","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"metadata"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"New user metadata values."}],"type":"paragraph"}],"name":"metadata"}],"kind":"parameters"},{"content":[{"text":"Return Value","type":"heading","level":2,"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"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"title":"userMetadata(_:)","url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Update user metadata."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userMetadata"},{"kind":"text","text":"(["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}}} \ 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 ff1c9194..8fdff3f5 100644 --- a/docs/data/documentation/auth0/userpatchattributes/username(_:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/username(_:connection:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/username(_:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"username","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"New username for the user.","type":"text"}],"type":"paragraph"}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Change the username.","type":"text"}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"username","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","platforms":[],"externalID":"s:5Auth019UserPatchAttributesC8username_10connectionACSS_SStF","roleHeading":"Instance Method","title":"username(_:connection:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"deprecated":true,"abstract":[{"type":"text","text":"Change the username."}],"url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","type":"topic","title":"username(_:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"}}} \ No newline at end of file +{"sections":[],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/username(_:connection:)"]}],"primaryContentSections":[{"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":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New username for the user."}]}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"kind":"symbol","metadata":{"roleHeading":"Instance Method","title":"username(_:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"username","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"externalID":"s:5Auth019UserPatchAttributesC8username_10connectionACSS_SStF","platforms":[],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"abstract":[{"type":"text","text":"Change the username."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"type":"topic","url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","role":"symbol","deprecated":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"username"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"username(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","abstract":[{"text":"Change the username.","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}}} \ 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 66458468..cf4368c1 100644 --- a/docs/data/documentation/auth0/users(token:domain:session:).json +++ b/docs/data/documentation/auth0/users(token:domain:session:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"text":"token","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":" = .shared) -> ","kind":"text"},{"text":"Users","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Management API token with the correct allowed scopes to perform the desired action.","type":"text"}]}],"name":"token"},{"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":"domain"},{"content":[{"type":"paragraph","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"}]}],"name":"session"}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Management API v2 client."}]}],"kind":"content"},{"content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"code":["Auth0.users(token: credentials.accessToken, domain: \"samples.us.auth0.com\")"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"You can only perform the following operations:","type":"text"}],"type":"paragraph"},{"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":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Link users"}]}]},{"content":[{"inlineContent":[{"text":"Unlink users","type":"text"}],"type":"paragraph"}]}],"type":"unorderedList"}],"kind":"content"}],"metadata":{"title":"users(token:domain:session:)","symbolKind":"func","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Function","externalID":"s:5Auth05users5token6domain7sessionAA5Users_pSS_SSSo12NSURLSessionCtF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"users"},{"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":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier","text":"Users"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:domain:session:)"]}],"abstract":[{"text":"Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":" client to perform operations with the Users","type":"text"},{"text":" ","type":"text"},{"text":"endpoints.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"kind":"symbol","abstract":[{"type":"text","text":"Auth0 "},{"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":" "},{"text":"endpoints.","type":"text"}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Users","preciseIdentifier":"s:5Auth05UsersP"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","url":"\/documentation\/auth0\/users(token:domain:session:)","title":"users(token:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","titleInlineContent":[{"text":"Management API v2","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:domain:session:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"func","roleHeading":"Function","externalID":"s:5Auth05users5token6domain7sessionAA5Users_pSS_SSSo12NSURLSessionCtF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"users"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"title":"users(token:domain:session:)","role":"symbol"},"abstract":[{"type":"text","text":"Auth0 "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":" client to perform operations with the Users","type":"text"},{"type":"text","text":" "},{"type":"text","text":"endpoints."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"text":" = .shared) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier","text":"Users"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Management API token with the correct allowed scopes to perform the desired action."}],"type":"paragraph"}],"name":"token"},{"name":"domain","content":[{"inlineContent":[{"type":"text","text":"Domain of your Auth0 account, for example "},{"code":"samples.us.auth0.com","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"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"}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"Auth0 Management API v2 client.","type":"text"}]}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0.users(token: credentials.accessToken, domain: \"samples.us.auth0.com\")"]},{"type":"paragraph","inlineContent":[{"text":"You can only perform the following operations:","type":"text"}]},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Get a user by ID","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Update the user’s "},{"type":"codeVoice","code":"user_metadata"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Link users","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"Unlink users","type":"text"}],"type":"paragraph"}]}],"type":"unorderedList"}]}],"references":{"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","title":"Management API v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","title":"users(token:domain:session:)","kind":"symbol","fragments":[{"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"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/users(token:domain:session:)","role":"symbol","type":"topic","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"},{"text":" ","type":"text"},{"type":"text","text":"endpoints."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"}}} \ 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 e4c9ab75..28e7c649 100644 --- a/docs/data/documentation/auth0/users(token:session:bundle:).json +++ b/docs/data/documentation/auth0/users(token:session:bundle:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)"},"metadata":{"modules":[{"name":"Auth0"}],"title":"users(token:session:bundle:)","externalID":"s:5Auth05users5token7session6bundleAA5Users_pSS_So12NSURLSessionCSo8NSBundleCtF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier"}],"symbolKind":"func","roleHeading":"Function"},"abstract":[{"text":"Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":" client to perform operations with the Users"},{"type":"text","text":" "},{"type":"text","text":"endpoints."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:session:bundle:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":" = .shared, "},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":" = .main) -> "},{"text":"Users","preciseIdentifier":"s:5Auth05UsersP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"token","content":[{"type":"paragraph","inlineContent":[{"text":"Management API token with the correct allowed scopes to perform the desired action.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"code":"URLSession","type":"codeVoice"},{"type":"text","text":" instance used for networking. Defaults to "},{"code":"URLSession.shared","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"session"},{"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"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"bundle"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Management API v2 client."}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"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":[{"inlineContent":[{"text":"Get a user by ID","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Update the user’s ","type":"text"},{"code":"user_metadata","type":"codeVoice"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Link users","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Unlink users","type":"text"}]}]}],"type":"unorderedList"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The Auth0 Domain is loaded from the "},{"type":"codeVoice","code":"Auth0.plist"},{"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>"],"syntax":"xml","type":"codeListing"},{"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"}],"type":"aside","style":"warning","name":"Warning"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"url":"\/documentation\/auth0\/users(token:session:bundle:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"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"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"text":"Users","kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","type":"topic","title":"users(token:session:bundle:)","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Auth0 "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":" client to perform operations with the Users","type":"text"},{"type":"text","text":" "},{"type":"text","text":"endpoints."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:session:bundle:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":" client to perform operations with the Users","type":"text"},{"type":"text","text":" "},{"type":"text","text":"endpoints."}],"metadata":{"symbolKind":"func","externalID":"s:5Auth05users5token7session6bundleAA5Users_pSS_So12NSURLSessionCSo8NSBundleCtF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Users","kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP"}],"modules":[{"name":"Auth0"}],"title":"users(token:session:bundle:)","roleHeading":"Function"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"users"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"text":" = .shared, ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"kind":"text","text":" = .main) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","text":"Users","preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Management API token with the correct allowed scopes to perform the desired action."}]}],"name":"token"},{"name":"session","content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"URLSession"},{"text":" instance used for networking. Defaults to ","type":"text"},{"code":"URLSession.shared","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"bundle","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":"."}]}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"Auth0 Management API v2 client.","type":"text"}],"type":"paragraph"}]},{"content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0.users(token: credentials.accessToken)"]},{"inlineContent":[{"type":"text","text":"You can only perform the following operations:"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"text":"Get a user by ID","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Update the user’s "},{"code":"user_metadata","type":"codeVoice"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Link users"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Unlink users"}],"type":"paragraph"}]}],"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>"],"syntax":"xml","type":"codeListing"},{"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","style":"warning","type":"aside"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Users","preciseIdentifier":"s:5Auth05UsersP"}],"url":"\/documentation\/auth0\/users(token:session:bundle:)","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"},{"text":"endpoints.","type":"text"}],"title":"users(token:session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users.json b/docs/data/documentation/auth0/users.json index f63da355..ce607dff 100644 --- a/docs/data/documentation/auth0/users.json +++ b/docs/data/documentation/auth0/users.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth05UsersP","roleHeading":"Protocol","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"role":"symbol","symbolKind":"protocol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"],"title":"Instance Properties"},{"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:)"]}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"],"title":"Related Documentation"}],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"title":"Inherits From","type":"inheritsFrom"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"Loggable","preciseIdentifier":"s:5Auth08LoggableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","text":"Trackable","preciseIdentifier":"s:5Auth09TrackableP","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"paths":["\/documentation\/auth0\/users"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates only the user’s "},{"code":"user_metadata","type":"codeVoice"},{"type":"text","text":" field."}],"url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","required":true,"title":"patch(_:userMetadata:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":", ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"kind":"symbol","required":true,"url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","defaultImplementations":1,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","type":"topic","title":"get(_:fields:include:)","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"kind":"symbol","abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"role":"symbol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Trackable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","url":"\/documentation\/auth0\/trackable","title":"Trackable"},"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"},{"text":"identityId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","title":"unlink(identityId:provider:fromUserId:)","required":true,"role":"symbol","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","abstract":[{"type":"text","text":"Removes an identity from a user."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","role":"symbol","title":"Loggable","url":"\/documentation\/auth0\/loggable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-5y4yy":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","defaultImplementations":1,"required":true,"title":"link(_:withUser:provider:connectionId:)","kind":"symbol","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","role":"symbol"},"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","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"title":"url","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","required":true,"url":"\/documentation\/auth0\/users\/url","type":"topic","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"token","type":"topic","abstract":[{"text":"The Management API token.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/users\/token","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","kind":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"required":true,"abstract":[{"text":"Links a user given its identifier with a secondary user given its ID token.","type":"text"},{"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":" "},{"type":"text","text":"the secondary user."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","title":"link(_:withOtherUserToken:)","type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","interfaceLanguage":"swift"},"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"],"title":"Related Documentation"}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"],"title":"Instance Properties"},{"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"}],"sections":[],"metadata":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}],"title":"Users","symbolKind":"protocol","modules":[{"name":"Auth0"}],"roleHeading":"Protocol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"role":"symbol","externalID":"s:5Auth05UsersP"},"relationshipsSections":[{"title":"Inherits From","kind":"relationships","type":"inheritsFrom","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:5Auth08LoggableP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","text":"Loggable"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth09TrackableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","text":"Trackable","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"type":"topic","title":"Trackable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"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","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"abstract":[{"type":"text","text":"Removes an identity from a user."}],"type":"topic","title":"unlink(identityId:provider:fromUserId:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)"},"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":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","title":"link(_:withUser:provider:connectionId:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"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"},{"kind":"text","text":"<["},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"type":"topic","title":"url","required":true,"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"kind":"symbol","url":"\/documentation\/auth0\/users\/url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"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"},{"type":"text","text":" "},{"type":"text","text":"the secondary user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","title":"link(_:withOtherUserToken:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withOtherUserToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"required":true,"role":"symbol","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","title":"get(_:fields:include:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"text":"include","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"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"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","kind":"symbol","url":"\/documentation\/auth0\/users\/token","title":"token","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"abstract":[{"text":"The Management API token.","type":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","kind":"symbol","abstract":[{"type":"text","text":"Updates only the user’s "},{"type":"codeVoice","code":"user_metadata"},{"text":" field.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"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","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"title":"patch(_:userMetadata:)","required":true,"type":"topic","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"type":"topic","title":"Loggable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"}}} \ 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 bc1321f4..8785fc51 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 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"] = [], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":" = true) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"identifier","content":[{"inlineContent":[{"type":"text","text":"ID of the user. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"text":" claim of the user’s ID token, or from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"text":" property of a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true},{"text":" instance.","type":"text"}],"type":"paragraph"}]},{"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"},{"name":"include","content":[{"type":"paragraph","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"}]}]}],"kind":"parameters"},{"content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield a user."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"inlineContent":[{"text":"By default it gets all the user’s attributes:","type":"text"}],"type":"paragraph"},{"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)\")"," }"," }"],"syntax":"swift"},{"inlineContent":[{"text":"You can select which attributes you want:","type":"text"}],"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:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"identities\", \"app_metadata\"], include: false)"," .start { print($0) }"]},{"type":"aside","style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"read:users"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln"},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"role":"symbol","extendedModule":"Auth0","externalID":"s:5Auth05UsersPAAE3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"title":"get(_:fields:include:)","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"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"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"],"title":"Related Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","type":"topic","title":"get(_:fields:include:)","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}]},"https://auth0.com/docs/api/management/v2":{"type":"link","identifier":"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"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":", ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"kind":"symbol","required":true,"url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","defaultImplementations":1,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","type":"topic","title":"get(_:fields:include:)","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]},"https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id":{"type":"link","identifier":"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","title":"Management API Endpoint"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"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"]]},"metadata":{"externalID":"s:5Auth05UsersPAAE3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"title":"get(_:fields:include:)","role":"symbol","roleHeading":"Instance Method"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"] = [], "},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" = true) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"name":"identifier","content":[{"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"},{"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":"fields","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"}]},{"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":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a user."}]}]},{"content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"By default it gets all the user’s attributes:"}]},{"syntax":"swift","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"},{"inlineContent":[{"type":"text","text":"You can select which attributes you want:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"]},{"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) }"],"type":"codeListing","syntax":"swift"},{"name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The token must have the scope "},{"code":"read:users","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note","type":"aside"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"required":true,"role":"symbol","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","title":"get(_:fields:include:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"text":"include","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"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"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","defaultImplementations":1,"type":"topic"},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","url":"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":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"get"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"title":"get(_:fields:include:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","kind":"symbol","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","type":"topic","abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"role":"symbol"},"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","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"title":"Management API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"}}} \ 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 9c413c30..c5ed8649 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 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww"},"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","externalID":"s:5Auth05UsersP3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","symbolKind":"method","required":true,"title":"get(_:fields:include:)"},"abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}]}]},{"parameters":[{"name":"identifier","content":[{"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"},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","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."}]}],"name":"fields"},{"name":"include","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."}]}]}],"kind":"parameters"},{"content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"inlineContent":[{"text":"A request that will yield a user.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"By default it gets all the user’s attributes:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","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":"paragraph","inlineContent":[{"text":"You can select which attributes you want:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"]},{"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) }"]},{"name":"Requires","content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"read:users","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","defaultImplementationsSections":[{"title":"Users Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":", ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"kind":"symbol","required":true,"url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","defaultImplementations":1,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","type":"topic","title":"get(_:fields:include:)","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"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":[{"type":"text","text":"Management API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","type":"link"},"https://auth0.com/docs/api/management/v2":{"type":"link","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"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","type":"topic","title":"get(_:fields:include:)","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}]}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","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\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"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 "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"type":"text","text":" instance."}],"type":"paragraph"}],"name":"identifier"},{"name":"fields","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":"include","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."}]}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield a user."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"By default it gets all the user’s attributes:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","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":[{"text":"You can select which attributes you want:","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"],"syntax":"swift"},{"inlineContent":[{"text":"You can even exclude some attributes:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"identities\", \"app_metadata\"], include: false)"," .start { print($0) }"],"type":"codeListing"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"read:users"},{"type":"text","text":" scope."}]}],"type":"aside","name":"Requires","style":"note"}]}],"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."}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln"],"title":"Users Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"required":true,"title":"get(_:fields:include:)","roleHeading":"Instance Method","externalID":"s:5Auth05UsersP3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"symbolKind":"method"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","interfaceLanguage":"swift"},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"required":true,"role":"symbol","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","title":"get(_:fields:include:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"text":"include","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"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"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"get"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"title":"get(_:fields:include:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","kind":"symbol","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","type":"topic","abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"role":"symbol"},"https://auth0.com/docs/api/management/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","title":"Management API v2"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"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","title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","type":"link"}}} \ 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 9f636647..25b9c139 100644 --- a/docs/data/documentation/auth0/users/link(_:withotherusertoken:).json +++ b/docs/data/documentation/auth0/users/link(_:withotherusertoken:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)"},"kind":"symbol","metadata":{"symbolKind":"method","role":"symbol","title":"link(_:withOtherUserToken:)","externalID":"s:5Auth05UsersP4link_18withOtherUserTokenAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_SStF","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withOtherUserToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}],"required":true},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"identifier","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withOtherUserToken"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"token"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"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\/ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"kind":"parameters","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"},{"type":"text","text":" claim of the primary 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"},{"text":" instance.","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"ID token of the secondary user.","type":"text"}],"type":"paragraph"}],"name":"token"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to link two users."}]}]},{"content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", withOtherUserToken: \"secondary-id-token\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"style":"note","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The token must have the scope "},{"code":"update:current_user_identities","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside"}],"kind":"content"}],"sections":[],"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"}],"abstract":[{"text":"Links a user given its identifier with a secondary user given its ID token.","type":"text"},{"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"},{"type":"text","text":" "},{"text":"the secondary user.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/users\/link(_:withotherusertoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","type":"link","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"titleInlineContent":[{"type":"text","text":"User Account Linking"}],"type":"link","url":"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"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","titleInlineContent":[{"text":"Management API v2","type":"text"}],"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"required":true,"abstract":[{"text":"Links a user given its identifier with a secondary user given its ID token.","type":"text"},{"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":" "},{"type":"text","text":"the secondary user."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","title":"link(_:withOtherUserToken:)","type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)"}}} \ No newline at end of file +{"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 "},{"type":"codeVoice","code":"identities"},{"type":"text","text":" attribute, which will represent"},{"type":"text","text":" "},{"text":"the secondary user.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withotherusertoken:)"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"kind":"text","text":" "},{"text":"token","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"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 "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the primary user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"text":" property of a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference"},{"type":"text","text":" instance."}]}]},{"name":"token","content":[{"inlineContent":[{"type":"text","text":"ID token of the secondary user."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"A request to link two users.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", withOtherUserToken: \"secondary-id-token\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"update:current_user_identities","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Requires","style":"note","type":"aside"}]}],"metadata":{"title":"link(_:withOtherUserToken:)","symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","role":"symbol","externalID":"s:5Auth05UsersP4link_18withOtherUserTokenAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_SStF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withOtherUserToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"text":">","kind":"text"}],"required":true},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"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"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"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","type":"link","title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities"},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"text":"Management API v2","type":"text"}],"title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link"},"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","type":"link","title":"User Account Linking","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"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"},{"type":"text","text":" "},{"type":"text","text":"the secondary user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","title":"link(_:withOtherUserToken:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withOtherUserToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"}}} \ 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 4b239543..2d4ba3f7 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 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"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"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"text":" ","kind":"text"},{"text":"userId","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject"},{"text":"], ","kind":"text"},{"text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"parameters":[{"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"},{"code":"sub","type":"codeVoice"},{"type":"text","text":" claim of the primary user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true},{"text":" instance.","type":"text"}]}],"name":"identifier"},{"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"},{"type":"codeVoice","code":"sub"},{"type":"text","text":" property of a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}]}],"name":"userId"},{"name":"provider","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections."}]}]},{"content":[{"inlineContent":[{"text":"ID of the connection for the secondary user.","type":"text"}],"type":"paragraph"}],"name":"connectionId"}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to link two users."}]}],"kind":"content"},{"kind":"content","content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"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","type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"type":"codeVoice","code":"update:users"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"metadata":{"role":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"connectionId","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<["},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"externalID":"s:5Auth05UsersP4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF","title":"link(_:withUser:provider:connectionId:)","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"references":{"https://auth0.com/docs/api/management/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","title":"Management API v2"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"title":"User Account Linking","titleInlineContent":[{"type":"text","text":"User Account Linking"}],"type":"link","url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-5y4yy":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","defaultImplementations":1,"required":true,"title":"link(_:withUser:provider:connectionId:)","kind":"symbol","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"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","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"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"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connectionId","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"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","type":"topic","role":"symbol","kind":"symbol","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}]}}} \ No newline at end of file +{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":" "},{"text":"userId","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"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"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject"},{"kind":"text","text":"], "},{"text":"ManagementError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"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"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference","isActive":true},{"text":" instance.","type":"text"}]}],"name":"identifier"},{"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"},{"isActive":true,"type":"reference","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."}]}]},{"name":"connectionId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the connection for the secondary user."}]}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to link two users."}]}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"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","type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"update:users"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"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"]}],"abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy"},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7"],"title":"Users Implementations"}],"metadata":{"symbolKind":"method","externalID":"s:5Auth05UsersP4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF","title":"link(_:withUser:provider:connectionId:)","modules":[{"name":"Auth0"}],"required":true,"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":"], "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"role":"symbol"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"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","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities"},"https://auth0.com/docs/api/management/v2":{"type":"link","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"}]},"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","type":"link","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","type":"topic","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"role":"symbol","title":"link(_:withUser:provider:connectionId:)","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"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"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","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","kind":"symbol"},"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":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","title":"link(_:withUser:provider:connectionId:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"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"},{"kind":"text","text":"<["},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 9833b44f..a1b9d6ab 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 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"identifier","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withUser"},{"text":" ","kind":"text"},{"text":"userId","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"identifier","content":[{"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"},{"text":" claim of the primary user’s ID token, or from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"type":"text","text":" property of a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference","isActive":true},{"text":" instance.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"ID of the secondary user. You can get this value from the "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" claim of the secondary 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."}],"type":"paragraph"}],"name":"userId"},{"name":"provider","content":[{"inlineContent":[{"type":"text","text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections."}],"type":"paragraph"}]},{"name":"connectionId","content":[{"inlineContent":[{"type":"text","text":"ID of the connection for the secondary user."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request to link two users."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", userId: \"secondary-user-id\", provider: \"auth0\", connectionId: \"connection-id\")"," .start { print($0) }"],"syntax":"swift"},{"style":"note","name":"Requires","content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"type":"codeVoice","code":"update:users"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside"}]}],"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"]]},"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"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7"]}],"metadata":{"symbolKind":"method","extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"text":"(","kind":"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"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"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"}],"role":"symbol","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth05UsersPAAE4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF","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"}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"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"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connectionId","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"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","type":"topic","role":"symbol","kind":"symbol","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-5y4yy":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","defaultImplementations":1,"required":true,"title":"link(_:withUser:provider:connectionId:)","kind":"symbol","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"titleInlineContent":[{"type":"text","text":"User Account Linking"}],"type":"link","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":{"titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","title":"Management API Endpoint","type":"link"},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"type":"text","text":"Management API v2"}],"type":"link","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/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":" "},{"text":"userId","kind":"internalParam"},{"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":"connectionId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? = nil) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<["},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","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 "},{"code":"sub","type":"codeVoice"},{"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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"type":"text","text":" instance."}]}],"name":"identifier"},{"name":"userId","content":[{"inlineContent":[{"text":"ID of the secondary user. You can get this value from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"type":"text","text":" claim of the secondary user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" property of a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"text":" instance.","type":"text"}],"type":"paragraph"}]},{"name":"provider","content":[{"inlineContent":[{"type":"text","text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the connection for the secondary user."}]}],"name":"connectionId"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"text":"A request to link two users.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"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","style":"note","content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"type":"codeVoice","code":"update:users"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"symbolKind":"method","title":"link(_:withUser:provider:connectionId:)","externalID":"s:5Auth05UsersPAAE4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","extendedModule":"Auth0","role":"symbol","modules":[{"name":"Auth0"}]},"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"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"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":[{"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/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","type":"topic","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"role":"symbol","title":"link(_:withUser:provider:connectionId:)","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"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"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","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"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/management/v2#!/Users/post_identities":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"title":"Management API Endpoint"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"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":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"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":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","title":"link(_:withUser:provider:connectionId:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"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"},{"kind":"text","text":"<["},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","type":"topic"}}} \ 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 e405c7ae..ffef4804 100644 --- a/docs/data/documentation/auth0/users/patch(_:attributes:).json +++ b/docs/data/documentation/auth0/users/patch(_:attributes:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"text":">","kind":"text"}]}]},{"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 "},{"type":"codeVoice","code":"sub"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference","isActive":true},{"text":" instance.","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Root attributes to be updated."}],"type":"paragraph"}],"name":"attributes"}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request that will yield the updated user."}],"type":"paragraph"}]},{"content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"inlineContent":[{"text":"For example, if you need to change the ","type":"text"},{"type":"codeVoice","code":"email"},{"text":":","type":"text"}],"type":"paragraph"},{"code":["let attributes = UserPatchAttributes().email(\"new.email@auth0.com\","," connection: \"Username-Password-Authentication\","," clientId: clientId)"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"Or, if you need to change the ","type":"text"},{"code":"user_metadata","type":"codeVoice"},{"text":":","type":"text"}],"type":"paragraph"},{"code":["let attributes = UserPatchAttributes().userMetadata([\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can even chain several changes together:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","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":"paragraph","inlineContent":[{"type":"text","text":"Then, just pass the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},{"type":"text","text":" to the patch method:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", attributes: attributes)"," .start { print($0) }"]},{"content":[{"inlineContent":[{"text":"The token must have one of the following scopes: ","type":"text"},{"code":"update:users","type":"codeVoice"},{"type":"text","text":", "},{"type":"codeVoice","code":"update:users_app_metadata"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"}],"kind":"content"}],"kind":"symbol","metadata":{"symbolKind":"method","platforms":[],"required":true,"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"externalID":"s:5Auth05UsersP5patch_10attributesAA7RequestVySDySSypGAA15ManagementErrorVGSS_AA19UserPatchAttributesCtF","title":"patch(_:attributes:)","role":"symbol","modules":[{"name":"Auth0"}]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"]}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This operation can no longer be performed from native apps for security reasons"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"variants":[{"paths":["\/documentation\/auth0\/users\/patch(_:attributes:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference","isActive":true},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"deprecated":true,"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"role":"symbol","required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"patch(_:attributes:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","type":"link","title":"Management API Endpoint","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/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"type":"link"}}} \ No newline at end of file +{"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","interfaceLanguage":"swift"},"sections":[],"metadata":{"roleHeading":"Instance Method","title":"patch(_:attributes:)","role":"symbol","externalID":"s:5Auth05UsersP5patch_10attributesAA7RequestVySDySSypGAA15ManagementErrorVGSS_AA19UserPatchAttributesCtF","platforms":[],"required":true,"modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"kind":"text","text":", "},{"text":"ManagementError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"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 "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" property of a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"type":"text","text":" instance."}],"type":"paragraph"}],"name":"identifier"},{"name":"attributes","content":[{"inlineContent":[{"type":"text","text":"Root attributes to be updated."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"A request that will yield the updated user.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"type":"paragraph","inlineContent":[{"text":"For example, if you need to change the ","type":"text"},{"type":"codeVoice","code":"email"},{"type":"text","text":":"}]},{"type":"codeListing","code":["let attributes = UserPatchAttributes().email(\"new.email@auth0.com\","," connection: \"Username-Password-Authentication\","," clientId: clientId)"],"syntax":"swift"},{"inlineContent":[{"text":"Or, if you need to change the ","type":"text"},{"code":"user_metadata","type":"codeVoice"},{"type":"text","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"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","isActive":true},{"type":"text","text":" to the patch method:"}]},{"type":"codeListing","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", attributes: attributes)"," .start { print($0) }"],"syntax":"swift"},{"type":"aside","style":"note","content":[{"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":"."}],"type":"paragraph"}],"name":"Requires"}],"kind":"content"}],"deprecationSummary":[{"inlineContent":[{"text":"This operation can no longer be performed from native apps for security reasons","type":"text"}],"type":"paragraph"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/patch(_:attributes:)"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"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 "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"UserPatchAttributes","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"type":"link","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"title":"patch(_:attributes:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"}}} \ 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 9f1c669f..1c9e1429 100644 --- a/docs/data/documentation/auth0/users/patch(_:usermetadata:).json +++ b/docs/data/documentation/auth0/users/patch(_:usermetadata:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/patch(_:usermetadata:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"],"title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"metadata":{"externalID":"s:5Auth05UsersP5patch_12userMetadataAA7RequestVySDySSypGAA15ManagementErrorVGSS_AHtF","title":"patch(_:userMetadata:)","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"role":"symbol","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"required":true},"kind":"symbol","abstract":[{"type":"text","text":"Updates only the user’s "},{"code":"user_metadata","type":"codeVoice"},{"type":"text","text":" field."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"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"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"identifier","content":[{"inlineContent":[{"text":"ID of the user to update. 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"},{"text":" property of a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}]},{"name":"userMetadata","content":[{"inlineContent":[{"text":"Metadata to update.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield the updated user."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"content":[{"inlineContent":[{"type":"text","text":"The token must have the "},{"type":"codeVoice","code":"update:current_user_metadata"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside","style":"note","name":"Requires"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"type":"text","text":"Management API v2"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates only the user’s "},{"code":"user_metadata","type":"codeVoice"},{"type":"text","text":" field."}],"url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","required":true,"title":"patch(_:userMetadata:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","title":"Management API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"}}} \ No newline at end of file +{"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"text":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","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"},{"text":" claim of the user’s ID token, or from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference","isActive":true},{"text":" instance.","type":"text"}]}],"name":"identifier"},{"name":"userMetadata","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Metadata to update."}]}]}]},{"content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield the updated user."}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"syntax":"swift"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The token must have the ","type":"text"},{"code":"update:current_user_metadata","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"type":"aside","style":"note","name":"Requires"}]}],"variants":[{"paths":["\/documentation\/auth0\/users\/patch(_:usermetadata:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Updates only the user’s "},{"type":"codeVoice","code":"user_metadata"},{"text":" field.","type":"text"}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","title":"patch(_:userMetadata:)","symbolKind":"method","externalID":"s:5Auth05UsersP5patch_12userMetadataAA7RequestVySDySSypGAA15ManagementErrorVGSS_AHtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","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"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","kind":"symbol","abstract":[{"type":"text","text":"Updates only the user’s "},{"type":"codeVoice","code":"user_metadata"},{"text":" field.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"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","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"title":"patch(_:userMetadata:)","required":true,"type":"topic","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","title":"Management API Endpoint","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}]}}} \ 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 0027df56..a45ac70a 100644 --- a/docs/data/documentation/auth0/users/token.json +++ b/docs/data/documentation/auth0/users/token.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The Management API token."}],"metadata":{"title":"token","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"required":true,"externalID":"s:5Auth05UsersP5tokenSSvp"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/users\/token"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"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","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"token","type":"topic","abstract":[{"text":"The Management API token.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/users\/token","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","kind":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/token"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"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"}],"platforms":["iOS"]}]}],"sections":[],"metadata":{"role":"symbol","title":"token","modules":[{"name":"Auth0"}],"externalID":"s:5Auth05UsersP5tokenSSvp","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"required":true,"roleHeading":"Instance Property"},"abstract":[{"text":"The Management API token.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"type":"link","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"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","kind":"symbol","url":"\/documentation\/auth0\/users\/token","title":"token","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"abstract":[{"text":"The Management API token.","type":"text"}],"required":true}}} \ 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 e39f7724..4000395a 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 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"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"}],"kind":"symbol","metadata":{"role":"symbol","externalID":"s:5Auth05UsersP6unlink10identityId8provider08fromUserE0AA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S2StF","title":"unlink(identityId:provider:fromUserId:)","modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"unlink"},{"kind":"text","text":"("},{"text":"identityId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","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"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}]},"abstract":[{"type":"text","text":"Removes an identity from a user."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"unlink"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"identityId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","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\/ManagementObject","text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the identity to remove."}]}],"name":"identityId"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the identity provider."}],"type":"paragraph"}],"name":"provider"},{"name":"identifier","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the user who owns the identity. You can get this value from the "},{"code":"sub","type":"codeVoice"},{"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"},{"text":" instance.","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request to remove an identity.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .unlink(identityId: \"identity-id\", provider: \"github\", fromUserId: \"user-id\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"style":"note","type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"update:users","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}]}],"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"},{"text":"identityId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","title":"unlink(identityId:provider:fromUserId:)","required":true,"role":"symbol","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","abstract":[{"type":"text","text":"Removes an identity from a user."}],"type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/delete_user_identity_by_user_id":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id","title":"Management API Endpoint","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"url":"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":{"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","titleInlineContent":[{"type":"text","text":"User Account Linking"}],"title":"User Account Linking","type":"link","url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]},"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"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"kind":"symbol","navigatorTitle":[{"text":"Request","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"Auth0 API request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","title":"Request","url":"\/documentation\/auth0\/request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"kind":"symbol","title":"ManagementError","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"type":"topic","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","title":"ManagementObject","url":"\/documentation\/auth0\/managementobject","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"title":"UserInfo","url":"\/documentation\/auth0\/userinfo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file +{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"unlink"},{"kind":"text","text":"("},{"kind":"externalParam","text":"identityId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"fromUserId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":"], ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"required":true,"title":"unlink(identityId:provider:fromUserId:)","externalID":"s:5Auth05UsersP6unlink10identityId8provider08fromUserE0AA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S2StF","roleHeading":"Instance Method"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Removes an identity from a user."}],"variants":[{"paths":["\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"unlink"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"identityId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"identityId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the identity to remove."}]}]},{"name":"provider","content":[{"type":"paragraph","inlineContent":[{"text":"Name of the identity provider.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"ID of the user who owns the identity. 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},{"type":"text","text":" instance."}]}],"name":"identifier"}]},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request to remove an identity.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .unlink(identityId: \"identity-id\", provider: \"github\", fromUserId: \"user-id\")"," .start { print($0) }"],"type":"codeListing"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"update:users","type":"codeVoice"},{"type":"text","text":"."}]}],"type":"aside","style":"note","name":"Requires"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"sections":[],"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":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"abstract":[{"type":"text","text":"Removes an identity from a user."}],"type":"topic","title":"unlink(identityId:provider:fromUserId:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementObject","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"symbol","url":"\/documentation\/auth0\/managementobject","type":"topic","abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"navigatorTitle":[{"text":"Request","kind":"identifier"}],"abstract":[{"type":"text","text":"Auth0 API request."}],"role":"symbol","url":"\/documentation\/auth0\/request","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","title":"ManagementError"},"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"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id","title":"Management API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}]},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"}}} \ 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 d105a3d5..ff6d5194 100644 --- a/docs/data/documentation/auth0/users/url.json +++ b/docs/data/documentation/auth0/users/url.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"metadata":{"title":"url","roleHeading":"Instance Property","externalID":"s:5Auth05UsersP3url10Foundation3URLVvp","required":true,"modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/url"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"title":"url","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","required":true,"url":"\/documentation\/auth0\/users\/url","type":"topic","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","title":"Users","url":"\/documentation\/auth0\/users","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"}]}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"},"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/url"]}],"metadata":{"title":"url","symbolKind":"property","externalID":"s:5Auth05UsersP3url10Foundation3URLVvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"required":true,"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"navigatorTitle":[{"text":"Users","kind":"identifier"}],"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/users","title":"Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"type":"link","url":"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"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"type":"topic","title":"url","required":true,"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"kind":"symbol","url":"\/documentation\/auth0\/users\/url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"}}} \ 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 cb12a4ae..87343d91 100644 --- a/docs/data/documentation/auth0/webauth(clientid:domain:session:).json +++ b/docs/data/documentation/auth0/webauth(clientid:domain:session:).json @@ -1 +1 @@ -{"abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true,"type":"reference"},{"text":".","type":"text"}],"metadata":{"symbolKind":"func","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"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"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"},{"text":"WebAuth","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP"}],"title":"webAuth(clientId:domain:session:)","modules":[{"name":"Auth0"}],"roleHeading":"Function","role":"symbol","externalID":"s:5Auth07webAuth8clientId6domain7sessionAA03WebC0_pSS_SSSo12NSURLSessionCtF"},"variants":[{"paths":["\/documentation\/auth0\/webauth(clientid:domain:session:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":" = .shared) -> ","kind":"text"},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Client ID of your Auth0 application."}]}],"name":"clientId"},{"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"},{"content":[{"type":"paragraph","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":"."}]}],"name":"session"}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Web Auth client."}]}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0.webAuth(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","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":"."}],"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"webAuth(clientId:domain:session:)","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth","kind":"typeIdentifier"}]},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"title":"Universal Login","titleInlineContent":[{"text":"Universal Login","type":"text"}],"type":"link","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":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth(clientid:domain:session:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":" = .shared) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"clientId","content":[{"inlineContent":[{"text":"Client ID of your Auth0 application.","type":"text"}],"type":"paragraph"}]},{"name":"domain","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":"session","content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"URLSession"},{"type":"text","text":" instance used for networking. Defaults to "},{"code":"URLSession.shared","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"inlineContent":[{"text":"Auth0 Web Auth client.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"code":["Auth0.webAuth(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"],"syntax":"swift","type":"codeListing"}]}],"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"},{"type":"text","text":"."}],"metadata":{"role":"symbol","title":"webAuth(clientId:domain:session:)","externalID":"s:5Auth07webAuth8clientId6domain7sessionAA03WebC0_pSS_SSSo12NSURLSessionCtF","modules":[{"name":"Auth0"}],"symbolKind":"func","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"kind":"text","text":"("},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":") -> ","kind":"text"},{"text":"WebAuth","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP"}],"roleHeading":"Function"},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","role":"symbol","title":"webAuth(clientId:domain:session:)","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"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":") -> "},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier"}]},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"titleInlineContent":[{"type":"text","text":"Universal Login"}],"title":"Universal Login","type":"link","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":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 b378bd5d..e9c8691c 100644 --- a/docs/data/documentation/auth0/webauth(session:bundle:).json +++ b/docs/data/documentation/auth0/webauth(session:bundle:).json @@ -1 +1 @@ -{"metadata":{"title":"webAuth(session:bundle:)","roleHeading":"Function","externalID":"s:5Auth07webAuth7session6bundleAA03WebC0_pSo12NSURLSessionC_So8NSBundleCtF","symbolKind":"func","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"kind":"text","text":"("},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier","text":"Bundle"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier","text":"WebAuth"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth(session:bundle:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","abstract":[{"type":"text","text":"Auth0 client for performing web-based authentication with "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":" = .shared, ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier","text":"Bundle"},{"text":" = Bundle.main) -> ","kind":"text"},{"text":"WebAuth","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"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":"."}]}],"name":"session"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Bundle used to locate the ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"text":" file. Defaults to ","type":"text"},{"code":"Bundle.main","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"bundle"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"Auth0 Web Auth client."}],"type":"paragraph"}]},{"content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"syntax":"swift","code":["Auth0.webAuth()"],"type":"codeListing"},{"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:"}],"type":"paragraph"},{"syntax":"xml","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"type":"codeListing"},{"style":"warning","content":[{"type":"paragraph","inlineContent":[{"text":"Calling this method without a valid ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file will crash your application."}]}],"type":"aside","name":"Warning"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","url":"\/documentation\/auth0\/webauth(session:bundle:)","type":"topic","title":"webAuth(session:bundle:)","kind":"symbol","abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"reference"},{"type":"text","text":"."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth"}]},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login","titleInlineContent":[{"type":"text","text":"Universal Login"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]}}} \ No newline at end of file +{"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"}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/webauth(session:bundle:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"kind":"text","text":"("},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"kind":"text","text":" = .shared, "},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":" = Bundle.main) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","kind":"typeIdentifier"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"session","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"code":"URLSession","type":"codeVoice"},{"type":"text","text":" instance used for networking. Defaults to "},{"code":"URLSession.shared","type":"codeVoice"},{"type":"text","text":"."}]}]},{"name":"bundle","content":[{"inlineContent":[{"type":"text","text":"Bundle used to locate the "},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file. Defaults to ","type":"text"},{"code":"Bundle.main","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"inlineContent":[{"text":"Auth0 Web Auth client.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["Auth0.webAuth()"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"The Auth0 Domain is loaded from the "},{"type":"codeVoice","code":"Auth0.plist"},{"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"},{"type":"aside","name":"Warning","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"}]}],"style":"warning"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"role":"symbol","roleHeading":"Function","title":"webAuth(session:bundle:)","modules":[{"name":"Auth0"}],"symbolKind":"func","externalID":"s:5Auth07webAuth7session6bundleAA03WebC0_pSo12NSURLSessionC_So8NSBundleCtF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webAuth"},{"text":"(","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"text":") -> ","kind":"text"},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth(session:bundle:)","abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true,"type":"reference"},{"type":"text","text":"."}],"title":"webAuth(session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"titleInlineContent":[{"type":"text","text":"Universal Login"}],"type":"link","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth.json b/docs/data/documentation/auth0/webauth.json index 3f70b2b2..0dea22cc 100644 --- a/docs/data/documentation/auth0/webauth.json +++ b/docs/data/documentation/auth0/webauth.json @@ -1 +1 @@ -{"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"}],"relationshipsSections":[{"title":"Inherits From","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"type":"inheritsFrom"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"},{"kind":"text","text":" : "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","preciseIdentifier":"s:5Auth08LoggableP","text":"Loggable","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","preciseIdentifier":"s:5Auth09TrackableP","text":"Trackable","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"externalID":"s:5Auth07WebAuthP","title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"symbolKind":"protocol","roleHeading":"Protocol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuth","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}]},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"],"title":"Related Documentation"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"references":{"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"title":"Universal Login","titleInlineContent":[{"type":"text","text":"Universal Login"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},"https://manage.auth0.com/#/apis":{"titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"type":"link","url":"https:\/\/manage.auth0.com\/#\/apis","identifier":"https:\/\/manage.auth0.com\/#\/apis","title":"Auth0 Dashboard"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"maxAge"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"title":"maxAge(_:)","required":true,"abstract":[{"text":"Specify a ","type":"text"},{"type":"codeVoice","code":"max_age"},{"type":"text","text":" parameter for authentication."},{"type":"text","text":" "},{"type":"text","text":"Sending this parameter will require the presence of the "},{"type":"codeVoice","code":"auth_time"},{"type":"text","text":" claim in the ID token."}],"type":"topic","url":"\/documentation\/auth0\/webauth\/maxage(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/leeway(_:)","abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","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":"."}],"required":true,"title":"leeway(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"leeway"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"type":"topic","title":"organization(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"abstract":[{"text":"Specify an organization identifier to log in to.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","url":"\/documentation\/auth0\/webauth\/organization(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","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","title":"useEphemeralSession()","kind":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","type":"topic","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","defaultImplementations":2,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","title":"clearSession(federated:)","kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuer","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Specify a custom issuer for ID token validation."},{"type":"text","text":" "},{"type":"text","text":"This value will be used instead of the Auth0 Domain."}],"required":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","url":"\/documentation\/auth0\/webauth\/issuer(_:)","title":"issuer(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"() "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"required":true,"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","title":"start()","url":"\/documentation\/auth0\/webauth\/start()-98znq"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"text":"Self","kind":"typeIdentifier"}],"title":"parameters(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/parameters(_:)","type":"topic","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"required":true,"title":"clearSession(federated:)","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","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:)-4zqyr","defaultImplementations":2,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Specify a ","type":"text"},{"code":"nonce","type":"codeVoice"},{"type":"text","text":" parameter for ID token validation."}],"title":"nonce(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","url":"\/documentation\/auth0\/webauth\/nonce(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"clientId","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","required":true,"url":"\/documentation\/auth0\/webauth\/clientid","type":"topic","abstract":[{"type":"text","text":"The Auth0 Client ID."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"required":true,"title":"url","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/url","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"abstract":[{"type":"text","text":"The Auth0 Domain URL."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useHTTPS","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"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."}],"url":"\/documentation\/auth0\/webauth\/usehttps()","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","title":"useHTTPS()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"}],"title":"telemetry","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","required":true,"url":"\/documentation\/auth0\/webauth\/telemetry","type":"topic","abstract":[{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invitationURL"},{"text":"(","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"invitationURL(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","type":"topic","abstract":[{"type":"text","text":"Specify an invitation URL to join an organization."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"state"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"title":"state(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/state(_:)","type":"topic","abstract":[{"type":"text","text":"Specify a "},{"code":"state","type":"codeVoice"},{"type":"text","text":" parameter that will be sent back after authentication to verify that the response"},{"text":" ","type":"text"},{"type":"text","text":"corresponds to your request."},{"text":" ","type":"text"},{"type":"text","text":"By default a random value is used."}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","role":"symbol","title":"Loggable","url":"\/documentation\/auth0\/loggable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","type":"topic","title":"clearSession(federated:callback:)","kind":"symbol","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"defaultImplementations":1,"required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"required":true,"type":"topic","abstract":[{"type":"text","text":"Specify the scopes that will be requested during authentication."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/scope(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"scope(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"required":true,"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"}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"connection","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","kind":"symbol","role":"symbol","title":"connection(_:)","url":"\/documentation\/auth0\/webauth\/connection(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"type":"topic","role":"symbol","title":"redirectURL(_:)","url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"onClose"},{"text":"((() -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")?) -> "},{"text":"Self","kind":"typeIdentifier"}],"title":"onClose(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/onclose(_:)","type":"topic","abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"type":"text","text":" closes, while the flow continues with the code exchange."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/webauth\/start()-qpqo","role":"symbol","abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"type":"topic","required":true,"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"kind":"symbol","abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"role":"symbol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Trackable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","url":"\/documentation\/auth0\/trackable","title":"Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"(("},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"start(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/start(_:)","type":"topic","abstract":[{"type":"text","text":"Starts the Web Auth flow."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"topic","title":"provider(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/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":" "},{"text":"authentication.","type":"text"},{"text":" ","type":"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"},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/apis","isActive":true},{"type":"text","text":"."}],"required":true,"role":"symbol","title":"audience(_:)","url":"\/documentation\/auth0\/webauth\/audience(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"audience"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol"},"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","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"connectionScope"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/webauth"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"externalID":"s:5Auth07WebAuthP","modules":[{"name":"Auth0"}],"symbolKind":"protocol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"title":"WebAuth","roleHeading":"Protocol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}]},"relationshipsSections":[{"type":"inheritsFrom","title":"Inherits From","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]}],"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"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"},{"text":" : ","kind":"text"},{"text":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","preciseIdentifier":"s:5Auth08LoggableP","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth09TrackableP","kind":"typeIdentifier","text":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"type":"text","text":"A type that can send the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"type":"topic","title":"Trackable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"connection","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","url":"\/documentation\/auth0\/webauth\/connection(_:)","title":"connection(_:)","role":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"required":true,"url":"\/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:)","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"url":"\/documentation\/auth0\/webauth\/audience(_:)","abstract":[{"text":"Specify an audience name for the API that your application will call using the access token returned after","type":"text"},{"type":"text","text":" "},{"type":"text","text":"authentication."},{"text":" ","type":"text"},{"type":"text","text":"This value must match the "},{"inlineContent":[{"text":"API Identifier","type":"text"}],"type":"strong"},{"text":" displayed in the APIs section of the ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/apis","isActive":true,"type":"reference"},{"type":"text","text":"."}],"title":"audience(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"nonce"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/nonce(_:)","abstract":[{"text":"Specify a ","type":"text"},{"code":"nonce","type":"codeVoice"},{"type":"text","text":" parameter for ID token validation."}],"title":"nonce(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"type":"topic","title":"Loggable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"required":true,"url":"\/documentation\/auth0\/webauth\/start()-98znq","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","kind":"symbol"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"type":"link","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login","titleInlineContent":[{"type":"text","text":"Universal Login"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"title":"clearSession(federated:)","required":true,"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"defaultImplementations":2,"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"title":"useHTTPS()","required":true,"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"},{"text":" ","type":"text"},{"type":"text","text":"macOS, the bundle identifier of the app will be used as a custom scheme."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/usehttps()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"useHTTPS","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"kind":"symbol","type":"topic"},"https://manage.auth0.com/#/apis":{"url":"https:\/\/manage.auth0.com\/#\/apis","title":"Auth0 Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/apis","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"role":"symbol","url":"\/documentation\/auth0\/telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"state"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"url":"\/documentation\/auth0\/webauth\/state(_:)","abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"state"},{"type":"text","text":" parameter that will be sent back after authentication to verify that the response"},{"type":"text","text":" "},{"text":"corresponds to your request.","type":"text"},{"type":"text","text":" "},{"text":"By default a random value is used.","type":"text"}],"title":"state(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"type":"topic","url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","required":true,"title":"connectionScope(_:)","kind":"symbol","abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"onClose","kind":"identifier"},{"kind":"text","text":"((() -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":")?) -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/onclose(_:)","abstract":[{"text":"Specify a callback to be called when the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"text":" closes, while the flow continues with the code exchange.","type":"text"}],"title":"onClose(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"organization"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"organization(_:)","kind":"symbol","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","url":"\/documentation\/auth0\/webauth\/organization(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"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"},{"text":")","kind":"text"}],"required":true,"url":"\/documentation\/auth0\/webauth\/start(_:)","abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"title":"start(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"maxAge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/maxage(_:)","abstract":[{"text":"Specify a ","type":"text"},{"type":"codeVoice","code":"max_age"},{"type":"text","text":" parameter for authentication."},{"type":"text","text":" "},{"type":"text","text":"Sending this parameter will require the presence of the "},{"type":"codeVoice","code":"auth_time"},{"type":"text","text":" claim in the ID token."}],"title":"maxAge(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","url":"\/documentation\/auth0\/webauth\/clientid","title":"clientId","required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"(["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/parameters(_:)","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"title":"parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"leeway"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"url":"\/documentation\/auth0\/webauth\/leeway(_:)","abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","text":" "},{"text":"This value represents the clock skew for the validation of date claims, for example ","type":"text"},{"type":"codeVoice","code":"exp"},{"text":".","type":"text"}],"title":"leeway(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}],"required":true,"url":"\/documentation\/auth0\/webauth\/telemetry","abstract":[{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference","isActive":true},{"text":" instance.","type":"text"}],"title":"telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"role":"symbol","title":"url","url":"\/documentation\/auth0\/webauth\/url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"required":true,"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","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"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":">"}],"required":true,"url":"\/documentation\/auth0\/webauth\/start()-qpqo","abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"title":"provider(_:)","url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","role":"symbol","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"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"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"title":"clearSession(federated:)","required":true,"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"defaultImplementations":2,"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"required":true,"abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"redirectURL","kind":"identifier"},{"kind":"text","text":"("},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","type":"topic","title":"redirectURL(_:)","url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"scope","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/scope(_:)","abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}],"title":"scope(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"identifier"},{"kind":"text","text":"("},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","abstract":[{"text":"Specify an invitation URL to join an organization.","type":"text"}],"title":"invitationURL(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"text":" ","type":"text"},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/useephemeralsession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"issuer","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"url":"\/documentation\/auth0\/webauth\/issuer(_:)","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(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","kind":"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 787f159b..50e70184 100644 --- a/docs/data/documentation/auth0/webauth/audience(_:).json +++ b/docs/data/documentation/auth0/webauth/audience(_:).json @@ -1 +1 @@ -{"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."},{"text":" ","type":"text"},{"text":"This value must match the ","type":"text"},{"type":"strong","inlineContent":[{"text":"API Identifier","type":"text"}]},{"type":"text","text":" displayed in the APIs section of the "},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/apis"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/audience(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"externalID":"s:5Auth07WebAuthP8audienceyxSSF","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","required":true,"modules":[{"name":"Auth0"}],"title":"audience(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"]}]},{"parameters":[{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"text":"Audience value. For example, ","type":"text"},{"code":"https:\/\/example.com\/api","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","references":{"https://auth0.com/docs/secure/tokens/access-tokens/get-access-tokens#control-access-token-audience":{"title":"Audience","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","type":"link","titleInlineContent":[{"type":"text","text":"Audience"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/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":" "},{"text":"authentication.","type":"text"},{"text":" ","type":"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"},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/apis","isActive":true},{"type":"text","text":"."}],"required":true,"role":"symbol","title":"audience(_:)","url":"\/documentation\/auth0\/webauth\/audience(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"audience"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"https://manage.auth0.com/#/apis":{"type":"link","title":"Auth0 Dashboard","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"identifier":"https:\/\/manage.auth0.com\/#\/apis","url":"https:\/\/manage.auth0.com\/#\/apis"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"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":" "},{"text":"authentication.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This value must match the "},{"inlineContent":[{"type":"text","text":"API Identifier"}],"type":"strong"},{"type":"text","text":" displayed in the APIs section of the "},{"identifier":"https:\/\/manage.auth0.com\/#\/apis","type":"reference","isActive":true},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"audience"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Audience value. For example, ","type":"text"},{"type":"codeVoice","code":"https:\/\/example.com\/api"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"audience"}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"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\/webauth\/audience(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"symbolKind":"method","externalID":"s:5Auth07WebAuthP8audienceyxSSF","title":"audience(_:)","modules":[{"name":"Auth0"}],"required":true,"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"audience"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"url":"\/documentation\/auth0\/webauth\/audience(_:)","abstract":[{"text":"Specify an audience name for the API that your application will call using the access token returned after","type":"text"},{"type":"text","text":" "},{"type":"text","text":"authentication."},{"text":" ","type":"text"},{"type":"text","text":"This value must match the "},{"inlineContent":[{"text":"API Identifier","type":"text"}],"type":"strong"},{"text":" displayed in the APIs section of the ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/apis","isActive":true,"type":"reference"},{"type":"text","text":"."}],"title":"audience(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"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","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","title":"Audience","titleInlineContent":[{"text":"Audience","type":"text"}],"type":"link"},"https://manage.auth0.com/#/apis":{"url":"https:\/\/manage.auth0.com\/#\/apis","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"title":"Auth0 Dashboard","type":"link","identifier":"https:\/\/manage.auth0.com\/#\/apis"}}} \ 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 ee71e3cd..17c04d84 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-3k5r3.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-3k5r3.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","interfaceLanguage":"swift"},"sections":[],"metadata":{"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthPAAE12clearSession9federatedySb_tYaKF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"extendedModule":"Auth0","role":"symbol","title":"clearSession(federated:)","modules":[{"name":"Auth0"}]},"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"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":" = false) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"title":"clearSession(federated:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"required":true,"title":"clearSession(federated:)","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","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:)-4zqyr","defaultImplementations":2,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","type":"topic","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","defaultImplementations":2,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","title":"clearSession(federated:)","kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" = false) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","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"]]},"metadata":{"title":"clearSession(federated:)","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthPAAE12clearSession9federatedySb_tYaKF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"symbolKind":"method","modules":[{"name":"Auth0"}],"extendedModule":"Auth0"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"title":"clearSession(federated:)","required":true,"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"defaultImplementations":2,"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"title":"clearSession(federated:)","required":true,"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"defaultImplementations":2,"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"title":"clearSession(federated:)","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic"}}} \ 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 a2b263d4..89805d79 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-4zqyr.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-4zqyr.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","role":"symbol","title":"clearSession(federated:)","symbolKind":"method","required":true,"externalID":"s:5Auth07WebAuthP12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF"},"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"federated","content":[{"inlineContent":[{"text":"If the identity provider session should be removed. Defaults to ","type":"text"},{"code":"false","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"A type-erased publisher.","type":"text"}]}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"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)"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}]},{"type":"codeListing","code":["Auth0"," .webAuth()"," .clearSession(federated: true)"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"syntax":"swift"},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Callback URL"}]},{"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"},{"text":" ","type":"text"},{"type":"text","text":"settings in the "},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note"},{"content":[{"inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference"},{"text":" on login, because there will","type":"text"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}],"type":"paragraph"}],"name":"Note","style":"note","type":"aside"}],"kind":"content"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr"]}],"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"}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"required":true,"title":"clearSession(federated:)","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","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:)-4zqyr","defaultImplementations":2,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"title":"clearSession(federated:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","type":"topic","abstract":[]},"https://auth0.com/docs/authenticate/login/logout":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link","title":"Logout","titleInlineContent":[{"type":"text","text":"Logout"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"https://manage.auth0.com/#/applications/":{"titleInlineContent":[{"type":"text","text":"Dashboard"}],"title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","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","title":"useEphemeralSession()","kind":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","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":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"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"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"federated","content":[{"inlineContent":[{"text":"If the identity provider session should be removed. Defaults to ","type":"text"},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","type":"heading","level":2,"text":"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)"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .webAuth()"," .clearSession(federated: true)"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"]},{"name":"Requires","style":"note","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":[{"type":"text","text":"Allowed Logout URLs"}]},{"type":"text","text":" field of your Auth0 application"},{"text":" ","type":"text"},{"type":"text","text":"settings in the "},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference","isActive":true},{"type":"text","text":"."}]}],"type":"aside"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference"},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}],"type":"aside","name":"Note"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"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"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr"},"metadata":{"required":true,"title":"clearSession(federated:)","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"symbolKind":"method","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"title":"clearSession(federated:)","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":">","kind":"text"}],"kind":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/logout":{"title":"Logout","type":"link","titleInlineContent":[{"type":"text","text":"Logout"}],"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"text":" ","type":"text"},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/useephemeralsession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"https://manage.auth0.com/#/applications/":{"type":"link","titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"title":"clearSession(federated:)","required":true,"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"defaultImplementations":2,"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 f9bdee53..2f4b1a37 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-6n4z6.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-6n4z6.json @@ -1 +1 @@ -{"metadata":{"title":"clearSession(federated:)","extendedModule":"Auth0","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth07WebAuthPAAE12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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":") -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"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"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":" = false) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"required":true,"title":"clearSession(federated:)","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","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:)-4zqyr","defaultImplementations":2,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","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":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","type":"topic","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","defaultImplementations":2,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","title":"clearSession(federated:)","kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":" = false) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","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"]]},"metadata":{"title":"clearSession(federated:)","symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthPAAE12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF","role":"symbol","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"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":">"}],"extendedModule":"Auth0"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"title":"clearSession(federated:)","required":true,"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"defaultImplementations":2,"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":">","kind":"text"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"title":"clearSession(federated:)","required":true,"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"defaultImplementations":2,"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic"}}} \ 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 2b232e15..d2d86967 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-8sl1o.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-8sl1o.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"text":"If the identity provider session should be removed. Defaults to ","type":"text"},{"code":"false","type":"codeVoice"},{"type":"text","text":"."}]}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"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"}]},{"type":"codeListing","syntax":"swift","code":["try await Auth0.webAuth().clearSession(federated: true)"]},{"content":[{"inlineContent":[{"text":"The ","type":"text"},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Allowed Logout URLs","type":"text"}]},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"},{"style":"note","type":"aside","name":"Note","content":[{"type":"paragraph","inlineContent":[{"text":"You don’t need to call this method if you are using ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference"},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}]}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"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"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"role":"symbol","required":true,"externalID":"s:5Auth07WebAuthP12clearSession9federatedySb_tYaKF","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"clearSession(federated:)"},"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"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"title":"clearSession(federated:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","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":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","type":"topic","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","defaultImplementations":2,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","title":"clearSession(federated:)","kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","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","title":"useEphemeralSession()","kind":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}]},"https://auth0.com/docs/authenticate/login/logout":{"titleInlineContent":[{"type":"text","text":"Logout"}],"title":"Logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"https://manage.auth0.com/#/applications/":{"type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"text":"Dashboard","type":"text"}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"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:)-6n4z6","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3"],"title":"WebAuth Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"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"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"externalID":"s:5Auth07WebAuthP12clearSession9federatedySb_tYaKF","roleHeading":"Instance Method","role":"symbol","title":"clearSession(federated:)"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"federated","content":[{"inlineContent":[{"text":"If the identity provider session should be removed. Defaults to ","type":"text"},{"code":"false","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"code":["do {"," try await Auth0.webAuth().clearSession()"," print(\"Session cookie cleared\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}]},{"syntax":"swift","code":["try await Auth0.webAuth().clearSession(federated: true)"],"type":"codeListing"},{"style":"note","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":" "},{"text":"settings in the ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference"},{"type":"text","text":"."}]}],"name":"Requires","type":"aside"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference"},{"text":" on login, because there will","type":"text"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}],"type":"aside","name":"Note","style":"note"}]}],"references":{"https://manage.auth0.com/#/applications/":{"title":"Dashboard","url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Dashboard"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"text":" ","type":"text"},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/useephemeralsession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"title":"clearSession(federated:)","required":true,"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"defaultImplementations":2,"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/logout":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"text":"Logout","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","title":"Logout"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"title":"clearSession(federated:)","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":">","kind":"text"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 8cb31dd9..8c947e36 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 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"kind":"text","text":" ("},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"If the identity provider session should be removed. Defaults to ","type":"text"},{"type":"codeVoice","code":"false"},{"text":".","type":"text"}]}],"name":"federated"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either an empty success case or an error."}]}],"name":"callback"}]},{"content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"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":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"]},{"type":"aside","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"}]},{"type":"text","text":" field of your Auth0 application"},{"text":" ","type":"text"},{"text":"settings in the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"text":".","type":"text"}]}],"style":"note"},{"name":"Note","content":[{"type":"paragraph","inlineContent":[{"text":"You don’t need to call this method if you are using ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference"},{"text":" on login, because there will","type":"text"},{"type":"text","text":" "},{"text":"be no shared cookie to remove.","type":"text"}]}],"style":"note","type":"aside"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3"]}],"metadata":{"roleHeading":"Instance Method","role":"symbol","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"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"required":true,"externalID":"s:5Auth07WebAuthP12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","title":"clearSession(federated:callback:)","modules":[{"name":"Auth0"}],"symbolKind":"method"},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61"],"title":"WebAuth Implementations"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"title":"Related Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","type":"topic","title":"clearSession(federated:callback:)","kind":"symbol","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"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","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","title":"useEphemeralSession()","kind":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","type":"topic","title":"clearSession(federated:callback:)","kind":"symbol","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"defaultImplementations":1,"required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}]},"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"},"https://manage.auth0.com/#/applications/":{"type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","titleInlineContent":[{"text":"Dashboard","type":"text"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"defaultImplementationsSections":[{"title":"WebAuth Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61"]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"If the identity provider session should be removed. Defaults to ","type":"text"},{"code":"false","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"federated"},{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"text":" containing either an empty success case or an error.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"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":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"],"syntax":"swift","type":"codeListing"},{"style":"note","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":[{"text":"Allowed Logout URLs","type":"text"}]},{"text":" field of your Auth0 application","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"settings in the "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Requires","type":"aside"},{"content":[{"type":"paragraph","inlineContent":[{"text":"You don’t need to call this method if you are using ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},{"text":" on login, because there will","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"be no shared cookie to remove."}]}],"type":"aside","style":"note","name":"Note"}]}],"metadata":{"roleHeading":"Instance Method","required":true,"externalID":"s:5Auth07WebAuthP12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","title":"clearSession(federated:callback:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"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":": ("},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}],"role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3"]}],"references":{"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Dashboard"}],"type":"link"},"https://auth0.com/docs/authenticate/login/logout":{"titleInlineContent":[{"text":"Logout","type":"text"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","title":"Logout","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"text":" ","type":"text"},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/useephemeralsession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"required":true,"url":"\/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:)","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"title":"clearSession(federated:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","type":"topic","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","url":"\/documentation\/auth0\/webauthresult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","role":"symbol","title":"WebAuthResult","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 d39d5a2c..8b678ecd 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 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","interfaceLanguage":"swift"},"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":" = false, "},{"kind":"externalParam","text":"callback"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"text":" (","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"text":"If the identity provider session should be removed. Defaults to ","type":"text"},{"code":"false","type":"codeVoice"},{"text":".","type":"text"}]}]},{"name":"callback","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."}]}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"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":"codeListing"},{"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":[{"type":"text","text":"The "},{"type":"strong","inlineContent":[{"type":"text","text":"Callback URL"}]},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"type":"text","text":"Allowed Logout URLs"}],"type":"strong"},{"text":" field of your Auth0 application","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"settings in the "},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true,"type":"reference"},{"text":".","type":"text"}]}]},{"name":"Note","content":[{"inlineContent":[{"text":"You don’t need to call this method if you are using ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference"},{"type":"text","text":" on login, because there will"},{"text":" ","type":"text"},{"text":"be no shared cookie to remove.","type":"text"}],"type":"paragraph"}],"style":"note","type":"aside"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"externalID":"s:5Auth07WebAuthPAAE12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":")"}],"symbolKind":"method","title":"clearSession(federated:callback:)","role":"symbol"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61"]}],"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":{"https://manage.auth0.com/#/applications/":{"title":"Dashboard","titleInlineContent":[{"text":"Dashboard","type":"text"}],"type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","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","title":"useEphemeralSession()","kind":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","type":"topic","title":"clearSession(federated:callback:)","kind":"symbol","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"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"https://auth0.com/docs/authenticate/login/logout":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"type":"text","text":"Logout"}],"title":"Logout","type":"link","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","type":"topic","title":"clearSession(federated:callback:)","kind":"symbol","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"defaultImplementations":1,"required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}]}}} \ No newline at end of file +{"sections":[],"metadata":{"title":"clearSession(federated:callback:)","symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthPAAE12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61"},"schemaVersion":{"minor":3,"major":0,"patch":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"kind":"symbol","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"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" = false, ","kind":"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"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"If the identity provider session should be removed. Defaults to ","type":"text"},{"type":"codeVoice","code":"false"},{"text":".","type":"text"}]}],"name":"federated"},{"name":"callback","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."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"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":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}]},{"code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"],"syntax":"swift","type":"codeListing"},{"type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"inlineContent":[{"type":"text","text":"Allowed Logout URLs"}],"type":"strong"},{"type":"text","text":" field of your Auth0 application"},{"text":" ","type":"text"},{"type":"text","text":"settings in the "},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"type":"text","text":"."}]}],"style":"note"},{"name":"Note","style":"note","type":"aside","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},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}],"type":"paragraph"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","url":"\/documentation\/auth0\/webauthresult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","role":"symbol","title":"WebAuthResult","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://auth0.com/docs/authenticate/login/logout":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"text":"Logout","type":"text"}],"title":"Logout","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"title":"clearSession(federated:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","type":"topic","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"required":true,"url":"\/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:)","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"text":" ","type":"text"},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/useephemeralsession()"},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/"}}} \ 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 2edfdd63..94490dec 100644 --- a/docs/data/documentation/auth0/webauth/clientid.json +++ b/docs/data/documentation/auth0/webauth/clientid.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"The Auth0 Client ID.","type":"text"}],"metadata":{"required":true,"externalID":"s:5Auth07WebAuthP8clientIdSSvp","title":"clientId","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"symbolKind":"property","roleHeading":"Instance Property","role":"symbol","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clientid"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"clientId","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","required":true,"url":"\/documentation\/auth0\/webauth\/clientid","type":"topic","abstract":[{"type":"text","text":"The Auth0 Client ID."}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth07WebAuthP8clientIdSSvp","roleHeading":"Instance Property","required":true,"title":"clientId","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}]},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clientid"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","url":"\/documentation\/auth0\/webauth\/clientid","title":"clientId","required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","type":"topic"}}} \ 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 3c9b1f0b..36605c53 100644 --- a/docs/data/documentation/auth0/webauth/connection(_:).json +++ b/docs/data/documentation/auth0/webauth/connection(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"connection","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"connection","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"parameters":[{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the connection. For example, "},{"code":"github","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"sections":[],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"connection","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"externalID":"s:5Auth07WebAuthP10connectionyxSSF","roleHeading":"Instance Method","title":"connection(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login"},{"text":" ","type":"text"},{"type":"text","text":"page itself. By default no connection is specified, so the Universal Login page will be displayed."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/connection(_:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"required":true,"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"}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"connection","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","kind":"symbol","role":"symbol","title":"connection(_:)","url":"\/documentation\/auth0\/webauth\/connection(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth07WebAuthP10connectionyxSSF","symbolKind":"method","title":"connection(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"connection"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","required":true},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login","type":"text"},{"type":"text","text":" "},{"type":"text","text":"page itself. By default no connection is specified, so the Universal Login page will be displayed."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connection"},{"kind":"text","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"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection. For example, "},{"code":"github","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"connection"}],"kind":"parameters"},{"content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/connection(_:)"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"connection","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","url":"\/documentation\/auth0\/webauth\/connection(_:)","title":"connection(_:)","role":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 bf0e02d9..325c1484 100644 --- a/docs/data/documentation/auth0/webauth/connectionscope(_:).json +++ b/docs/data/documentation/auth0/webauth/connectionscope(_:).json @@ -1 +1 @@ -{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"connectionScope","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"connectionScope","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested OAuth2\/social scope values. For example,","type":"text"},{"type":"text","text":" "},{"code":"public_repo read:user","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"connectionScope"}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"sections":[],"metadata":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"connectionScope","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"externalID":"s:5Auth07WebAuthP15connectionScopeyxSSF","roleHeading":"Instance Method","title":"connectionScope(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/connectionscope(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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","title":"Connection Scopes","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/WebAuth/connectionScope(_:)":{"abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"title":"connectionScope(_:)","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"connectionScope"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth07WebAuthP15connectionScopeyxSSF","required":true,"modules":[{"name":"Auth0"}],"title":"connectionScope(_:)","symbolKind":"method","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Space-separated list of requested OAuth2\/social scope values. For example,","type":"text"},{"type":"text","text":" "},{"type":"codeVoice","code":"public_repo read:user"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"connectionScope"}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp"]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/connectionscope(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"type":"topic","url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","required":true,"title":"connectionScope(_:)","kind":"symbol","abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)"},"https://auth0.com/docs/authenticate/identity-providers/adding-scopes-for-an-external-idp":{"type":"link","url":"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","titleInlineContent":[{"text":"Connection Scopes","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 9fc22774..51420145 100644 --- a/docs/data/documentation/auth0/webauth/invitationurl(_:).json +++ b/docs/data/documentation/auth0/webauth/invitationurl(_:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/invitationurl(_:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invitationURL"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"invitationURL","content":[{"inlineContent":[{"type":"text","text":"Invitation URL for the organization."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","interfaceLanguage":"swift"},"sections":[],"metadata":{"externalID":"s:5Auth07WebAuthP13invitationURLyx10Foundation0E0VF","role":"symbol","roleHeading":"Instance Method","required":true,"modules":[{"name":"Auth0"}],"title":"invitationURL(_:)","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invitationURL"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"Specify an invitation URL to join an organization.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invitationURL"},{"text":"(","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"invitationURL(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","type":"topic","abstract":[{"type":"text","text":"Specify an invitation URL to join an organization."}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/invitationurl(_:)"]}],"kind":"symbol","abstract":[{"type":"text","text":"Specify an invitation URL to join an organization."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"invitationURL","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"invitationURL","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Invitation URL for the organization."}]}]}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"identifier"},{"kind":"text","text":"("},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"title":"invitationURL(_:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth07WebAuthP13invitationURLyx10Foundation0E0VF","symbolKind":"method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"identifier"},{"kind":"text","text":"("},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","abstract":[{"text":"Specify an invitation URL to join an organization.","type":"text"}],"title":"invitationURL(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 0bc867f7..336df280 100644 --- a/docs/data/documentation/auth0/webauth/issuer(_:).json +++ b/docs/data/documentation/auth0/webauth/issuer(_:).json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Method","role":"symbol","externalID":"s:5Auth07WebAuthP6issueryxSSF","symbolKind":"method","title":"issuer(_:)","modules":[{"name":"Auth0"}],"required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"issuer","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/issuer(_:)"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"issuer"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"issuer"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Custom issuer value. For example, ","type":"text"},{"type":"codeVoice","code":"https:\/\/example.com\/"},{"type":"text","text":"."}]}],"name":"issuer"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","abstract":[{"type":"text","text":"Specify a custom issuer for ID token validation."},{"text":" ","type":"text"},{"type":"text","text":"This value will be used instead of the Auth0 Domain."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuer","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Specify a custom issuer for ID token validation."},{"type":"text","text":" "},{"type":"text","text":"This value will be used instead of the Auth0 Domain."}],"required":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","url":"\/documentation\/auth0\/webauth\/issuer(_:)","title":"issuer(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]}}} \ No newline at end of file +{"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."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"paths":["\/documentation\/auth0\/webauth\/issuer(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuer"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"roleHeading":"Instance Method","title":"issuer(_:)","required":true,"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth07WebAuthP6issueryxSSF"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"issuer"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"issuer","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"]}]},{"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":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"issuer","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"url":"\/documentation\/auth0\/webauth\/issuer(_:)","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(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 5c09ba04..94606731 100644 --- a/docs/data/documentation/auth0/webauth/leeway(_:).json +++ b/docs/data/documentation/auth0/webauth/leeway(_:).json @@ -1 +1 @@ -{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"leeway"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"title":"leeway(_:)","externalID":"s:5Auth07WebAuthP6leewayyxSiF","role":"symbol","roleHeading":"Instance Method","symbolKind":"method"},"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"]]},"kind":"symbol","abstract":[{"text":"Specify a leeway amount for ID token validation.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This value represents the clock skew for the validation of date claims, for example "},{"code":"exp","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/leeway(_:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"leeway"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"leeway"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"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 "},{"type":"codeVoice","code":"60_000"},{"text":" (1 minute).","type":"text"}]}]}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"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"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/leeway(_:)","abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","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":"."}],"required":true,"title":"leeway(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"leeway"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"leeway"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"leeway","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"]}]},{"parameters":[{"name":"leeway","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Number of milliseconds. Defaults to "},{"type":"codeVoice","code":"60_000"},{"type":"text","text":" (1 minute)."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"kind":"symbol","metadata":{"roleHeading":"Instance Method","required":true,"symbolKind":"method","role":"symbol","title":"leeway(_:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"leeway"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP6leewayyxSiF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"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"},{"type":"codeVoice","code":"exp"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/leeway(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"leeway"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"url":"\/documentation\/auth0\/webauth\/leeway(_:)","abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","text":" "},{"text":"This value represents the clock skew for the validation of date claims, for example ","type":"text"},{"type":"codeVoice","code":"exp"},{"text":".","type":"text"}],"title":"leeway(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","kind":"symbol"}}} \ 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 1a68e2b1..7f8bdfa1 100644 --- a/docs/data/documentation/auth0/webauth/maxage(_:).json +++ b/docs/data/documentation/auth0/webauth/maxage(_:).json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"Specify a ","type":"text"},{"code":"max_age","type":"codeVoice"},{"text":" parameter for authentication.","type":"text"},{"type":"text","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."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"maxAge"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"maxAge","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Number of milliseconds.","type":"text"}]}],"name":"maxAge"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"maxAge"},{"kind":"text","text":"("},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"externalID":"s:5Auth07WebAuthP6maxAgeyxSiF","roleHeading":"Instance Method","title":"maxAge(_:)","modules":[{"name":"Auth0"}],"required":true,"symbolKind":"method","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/maxage(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"maxAge"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"title":"maxAge(_:)","required":true,"abstract":[{"text":"Specify a ","type":"text"},{"type":"codeVoice","code":"max_age"},{"type":"text","text":" parameter for authentication."},{"type":"text","text":" "},{"type":"text","text":"Sending this parameter will require the presence of the "},{"type":"codeVoice","code":"auth_time"},{"type":"text","text":" claim in the ID token."}],"type":"topic","url":"\/documentation\/auth0\/webauth\/maxage(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/maxage(_:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)"},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"maxAge","kind":"identifier"},{"kind":"text","text":"("},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"title":"maxAge(_:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP6maxAgeyxSiF","symbolKind":"method","required":true},"abstract":[{"type":"text","text":"Specify a "},{"code":"max_age","type":"codeVoice"},{"type":"text","text":" parameter for authentication."},{"type":"text","text":" "},{"text":"Sending this parameter will require the presence of the ","type":"text"},{"type":"codeVoice","code":"auth_time"},{"type":"text","text":" claim in the ID token."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"maxAge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"maxAge"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"maxAge","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Number of milliseconds."}]}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"maxAge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/maxage(_:)","abstract":[{"text":"Specify a ","type":"text"},{"type":"codeVoice","code":"max_age"},{"type":"text","text":" parameter for authentication."},{"type":"text","text":" "},{"type":"text","text":"Sending this parameter will require the presence of the "},{"type":"codeVoice","code":"auth_time"},{"type":"text","text":" claim in the ID token."}],"title":"maxAge(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 c5cb17c0..962a9411 100644 --- a/docs/data/documentation/auth0/webauth/nonce(_:).json +++ b/docs/data/documentation/auth0/webauth/nonce(_:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Method","title":"nonce(_:)","required":true,"externalID":"s:5Auth07WebAuthP5nonceyxSSF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"abstract":[{"text":"Specify a ","type":"text"},{"type":"codeVoice","code":"nonce"},{"type":"text","text":" parameter for ID token validation."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"nonce"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"nonce","content":[{"inlineContent":[{"type":"text","text":"Nonce value."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/nonce(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Specify a ","type":"text"},{"code":"nonce","type":"codeVoice"},{"type":"text","text":" parameter for ID token validation."}],"title":"nonce(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","url":"\/documentation\/auth0\/webauth\/nonce(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/nonce(_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"metadata":{"symbolKind":"method","title":"nonce(_:)","externalID":"s:5Auth07WebAuthP5nonceyxSSF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"roleHeading":"Instance Method","required":true,"role":"symbol","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"Specify a "},{"code":"nonce","type":"codeVoice"},{"text":" parameter for ID token validation.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"nonce","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Nonce value.","type":"text"}]}],"name":"nonce"}]},{"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"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"nonce"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/nonce(_:)","abstract":[{"text":"Specify a ","type":"text"},{"code":"nonce","type":"codeVoice"},{"type":"text","text":" parameter for ID token validation."}],"title":"nonce(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 5f03a322..e712c9ee 100644 --- a/docs/data/documentation/auth0/webauth/onclose(_:).json +++ b/docs/data/documentation/auth0/webauth/onclose(_:).json @@ -1 +1 @@ -{"abstract":[{"text":"Specify a callback to be called when the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" closes, while the flow continues with the code exchange."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"callback"},{"text":": (() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")?) -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A callback to be executed"}]}],"name":"callback"}]},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","externalID":"s:5Auth07WebAuthP7onCloseyxyycSgF","title":"onClose(_:)","roleHeading":"Instance Method","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"onClose"},{"text":"((() -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")?) -> "},{"kind":"typeIdentifier","text":"Self"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/onclose(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"onClose"},{"text":"((() -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")?) -> "},{"text":"Self","kind":"typeIdentifier"}],"title":"onClose(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/onclose(_:)","type":"topic","abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"type":"text","text":" closes, while the flow continues with the code exchange."}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"onClose"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": (() -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]}]},{"kind":"parameters","parameters":[{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A callback to be executed"}]}]}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/onclose(_:)"]}],"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP7onCloseyxyycSgF","required":true,"role":"symbol","symbolKind":"method","title":"onClose(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"onClose","kind":"identifier"},{"kind":"text","text":"((() -> "},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"abstract":[{"text":"Specify a callback to be called when the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference"},{"text":" closes, while the flow continues with the code exchange.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"onClose","kind":"identifier"},{"kind":"text","text":"((() -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":")?) -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/onclose(_:)","abstract":[{"text":"Specify a callback to be called when the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"text":" closes, while the flow continues with the code exchange.","type":"text"}],"title":"onClose(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 06da6e1f..67cbf96f 100644 --- a/docs/data/documentation/auth0/webauth/organization(_:).json +++ b/docs/data/documentation/auth0/webauth/organization(_:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"organization","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"organization","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}]},{"parameters":[{"name":"organization","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the organization."}]}]}],"kind":"parameters"},{"content":[{"type":"heading","text":"Return Value","anchor":"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"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/organization(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"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"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"organization"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"externalID":"s:5Auth07WebAuthP12organizationyxSSF","role":"symbol","title":"organization(_:)","roleHeading":"Instance Method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"type":"topic","title":"organization(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"abstract":[{"text":"Specify an organization identifier to log in to.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","url":"\/documentation\/auth0\/webauth\/organization(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)"},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"organization","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"organization"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"]}]},{"parameters":[{"name":"organization","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the organization."}]}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"metadata":{"title":"organization(_:)","required":true,"externalID":"s:5Auth07WebAuthP12organizationyxSSF","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"organization"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"roleHeading":"Instance Method","role":"symbol","symbolKind":"method"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/organization(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"organization"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"organization(_:)","kind":"symbol","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","url":"\/documentation\/auth0\/webauth\/organization(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 cafc3b68..3694faaa 100644 --- a/docs/data/documentation/auth0/webauth/parameters(_:).json +++ b/docs/data/documentation/auth0/webauth/parameters(_:).json @@ -1 +1 @@ -{"abstract":[{"text":"Specify additional parameters for authentication.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/parameters(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"text":"Self","kind":"typeIdentifier"}],"title":"parameters(_:)","required":true,"externalID":"s:5Auth07WebAuthP10parametersyxSDyS2SGF","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"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"]]},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"text":"Self","kind":"typeIdentifier"}],"title":"parameters(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/parameters(_:)","type":"topic","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"text":"Self","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional authentication parameters.","type":"text"}]}],"name":"parameters"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"Specify additional parameters for authentication.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/parameters(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"title":"parameters(_:)","required":true,"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP10parametersyxSDyS2SGF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"symbolKind":"method","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"(["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/parameters(_:)","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"title":"parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 c04f33a3..95860bf7 100644 --- a/docs/data/documentation/auth0/webauth/provider(_:).json +++ b/docs/data/documentation/auth0/webauth/provider(_:).json @@ -1 +1 @@ -{"metadata":{"symbolKind":"method","externalID":"s:5Auth07WebAuthP8provideryxAA0bC9UserAgent_p10Foundation3URLV_ys6ResultOyytAA0bC5ErrorVGctcF","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"provider(_:)","required":true},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"provider","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"provider","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"text":" ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"provider","content":[{"inlineContent":[{"text":"A custom Web Auth provider.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"type":"aside","name":"Note","content":[{"inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference"},{"type":"text","text":". Use either one or the other, because"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},{"text":" will only work with the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"type":"paragraph"}],"style":"note"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/provider(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"type":"topic","url":"\/documentation\/auth0\/useragents","kind":"article","role":"article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","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","title":"useEphemeralSession()","kind":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"kind":"symbol","abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"type":"text","text":" to perform a web-based operation."},{"text":" ","type":"text"},{"type":"text","text":"The "},{"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."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"topic","title":"provider(_:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"provider"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"provider","kind":"internalParam"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"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"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"provider","content":[{"inlineContent":[{"type":"text","text":"A custom Web Auth provider."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"content":[{"inlineContent":[{"text":"Don’t use this method along with ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true,"type":"reference"},{"type":"text","text":". Use either one or the other, because"},{"text":" ","type":"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"},{"text":" implementation.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note","name":"Note"}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/provider(_:)"]}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"],"title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"provider"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"title":"provider(_:)","externalID":"s:5Auth07WebAuthP8provideryxAA0bC9UserAgent_p10Foundation3URLV_ys6ResultOyytAA0bC5ErrorVGctcF","roleHeading":"Instance Method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"title":"provider(_:)","url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","role":"symbol","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"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"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/useragents"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference"},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProvider","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"text":" ","type":"text"},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/useephemeralsession()"}}} \ 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 b109ceec..05eba5a7 100644 --- a/docs/data/documentation/auth0/webauth/redirecturl(_:).json +++ b/docs/data/documentation/auth0/webauth/redirecturl(_:).json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)"},"metadata":{"externalID":"s:5Auth07WebAuthP11redirectURLyx10Foundation0E0VF","required":true,"symbolKind":"method","roleHeading":"Instance Method","role":"symbol","title":"redirectURL(_:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"redirectURL","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"redirectURL","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Custom redirect URL."}]}],"name":"redirectURL"}]},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/redirecturl(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"type":"topic","role":"symbol","title":"redirectURL(_:)","url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)"},"kind":"symbol","metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"required":true,"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"redirectURL"},{"text":"(","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","externalID":"s:5Auth07WebAuthP11redirectURLyx10Foundation0E0VF","title":"redirectURL(_:)"},"abstract":[{"text":"Specify a custom redirect URL to be used.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/redirecturl(_:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"redirectURL","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"redirectURL","content":[{"type":"paragraph","inlineContent":[{"text":"Custom redirect URL.","type":"text"}]}]}]},{"content":[{"type":"heading","anchor":"return-value","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"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"required":true,"abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"redirectURL","kind":"identifier"},{"kind":"text","text":"("},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","type":"topic","title":"redirectURL(_:)","url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","kind":"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 1f8a0617..4b0a60ed 100644 --- a/docs/data/documentation/auth0/webauth/scope(_:).json +++ b/docs/data/documentation/auth0/webauth/scope(_:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth07WebAuthP5scopeyxSSF","title":"scope(_:)","modules":[{"name":"Auth0"}],"required":true,"role":"symbol","symbolKind":"method","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"scope","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"scope","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values. For example,","type":"text"},{"type":"text","text":" "},{"code":"openid profile email offline_access","type":"codeVoice"},{"text":".","type":"text"}]}]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/scope(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"],"title":"Related Documentation"}],"kind":"symbol","abstract":[{"type":"text","text":"Specify the scopes that will be requested during authentication."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"required":true,"type":"topic","abstract":[{"type":"text","text":"Specify the scopes that will be requested during authentication."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/scope(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"scope(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","role":"symbol"},"https://auth0.com/docs/get-started/apis/scopes":{"title":"Scopes","type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","titleInlineContent":[{"type":"text","text":"Scopes"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. For example,"},{"text":" ","type":"text"},{"code":"openid profile email offline_access","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth07WebAuthP5scopeyxSSF","required":true,"title":"scope(_:)","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/scope(_:)"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"scope","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"required":true,"url":"\/documentation\/auth0\/webauth\/scope(_:)","abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}],"title":"scope(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","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":[{"text":"Scopes","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 10ed3340..f69503d3 100644 --- a/docs/data/documentation/auth0/webauth/start()-98znq.json +++ b/docs/data/documentation/auth0/webauth/start()-98znq.json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"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"},{"text":" -> ","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The result of the Web Auth flow."}]}]},{"content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["do {"," let credentials = try await Auth0.webAuth().start()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"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 it will throw a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},{"type":"text","text":" error."}],"type":"paragraph"},{"name":"Throws","style":"note","type":"aside","content":[{"inlineContent":[{"text":"An error of type ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","isActive":true,"type":"reference"},{"type":"text","text":"."}],"type":"paragraph"}]},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"inlineContent":[{"type":"text","text":"Allowed Callback URLs"}],"type":"strong"},{"text":" field of your Auth0","type":"text"},{"type":"text","text":" "},{"text":"application settings in the ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference"},{"type":"text","text":"."}]}],"name":"Requires"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}],"required":true,"role":"symbol","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP5startAA11CredentialsCyYaKF","title":"start()"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq"},"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start()-98znq"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"() "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"required":true,"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","title":"start()","url":"\/documentation\/auth0\/webauth\/start()-98znq"},"https://manage.auth0.com/#/applications/":{"titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","type":"link","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","url":"\/documentation\/auth0\/webautherror\/usercancelled","type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","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},{"text":".","type":"text"}],"kind":"symbol","title":"userCancelled"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"text":"The result of the Web Auth flow.","type":"text"}],"type":"paragraph"}]},{"content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"syntax":"swift","type":"codeListing","code":["do {"," let credentials = try await Auth0.webAuth().start()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"type":"paragraph","inlineContent":[{"text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,","type":"text"},{"type":"text","text":" "},{"type":"text","text":"and it will throw a "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"reference"},{"type":"text","text":" error."}]},{"content":[{"inlineContent":[{"type":"text","text":"An error of type "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","isActive":true},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside","name":"Throws","style":"note"},{"type":"aside","style":"note","name":"Requires","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 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\/","isActive":true,"type":"reference"},{"type":"text","text":"."}]}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"fragments":[{"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"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}],"required":true,"externalID":"s:5Auth07WebAuthP5startAA11CredentialsCyYaKF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"start()","role":"symbol","symbolKind":"method"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start()-98znq"]}],"kind":"symbol","sections":[],"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"required":true,"url":"\/documentation\/auth0\/webauth\/start()-98znq","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","title":"userCancelled","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","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","isActive":true,"type":"reference"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 ebb2b1fd..942dbdb6 100644 --- a/docs/data/documentation/auth0/webauth/start()-qpqo.json +++ b/docs/data/documentation/auth0/webauth/start()-qpqo.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start()-qpqo"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","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"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A type-erased publisher.","type":"text"}]}],"kind":"content"},{"content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"type":"codeListing","syntax":"swift","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)"]},{"type":"paragraph","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":"aside","name":"Requires","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"inlineContent":[{"text":"Callback URL","type":"text"}],"type":"strong"},{"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"},{"type":"text","text":" "},{"text":"application settings in the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","role":"symbol","externalID":"s:5Auth07WebAuthP5start7Combine12AnyPublisherVyAA11CredentialsCAA0bC5ErrorVGyF","modules":[{"name":"Auth0"}],"required":true,"symbolKind":"method","title":"start()"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","url":"\/documentation\/auth0\/webautherror\/usercancelled","type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","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},{"text":".","type":"text"}],"kind":"symbol","title":"userCancelled"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/webauth\/start()-qpqo","role":"symbol","abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"type":"topic","required":true,"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"https://manage.auth0.com/#/applications/":{"title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP5start7Combine12AnyPublisherVyAA11CredentialsCAA0bC5ErrorVGyF","required":true,"modules":[{"name":"Auth0"}],"role":"symbol","title":"start()","symbolKind":"method"},"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/start()-qpqo"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"A type-erased publisher.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"syntax":"swift","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)"],"type":"codeListing"},{"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"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},{"type":"text","text":" error."}],"type":"paragraph"},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"text":"Callback URL","type":"text"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"type":"strong","inlineContent":[{"text":"Allowed Callback URLs","type":"text"}]},{"text":" field of your Auth0","type":"text"},{"type":"text","text":" "},{"text":"application settings in the ","type":"text"},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"type":"text","text":"."}]}],"name":"Requires"}],"kind":"content"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"},"https://manage.auth0.com/#/applications/":{"title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","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"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":">"}],"required":true,"url":"\/documentation\/auth0\/webauth\/start()-qpqo","abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","title":"userCancelled","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","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","isActive":true,"type":"reference"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 647f8491..cc03048e 100644 --- a/docs/data/documentation/auth0/webauth/start(_:).json +++ b/docs/data/documentation/auth0/webauth/start(_:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/webauth\/start(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"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"},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"]},{"inlineContent":[{"text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,","type":"text"},{"type":"text","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","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"}]},{"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"}]}],"type":"aside","style":"note"}],"kind":"content"}],"metadata":{"title":"start(_:)","required":true,"externalID":"s:5Auth07WebAuthP5startyyys6ResultOyAA11CredentialsCAA0bC5ErrorVGcF","role":"symbol","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"(("},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"modules":[{"name":"Auth0"}]},"references":{"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Dashboard"}],"type":"link","title":"Dashboard"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"(("},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"start(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/start(_:)","type":"topic","abstract":[{"type":"text","text":"Starts the Web Auth flow."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"type":"topic","title":"Credentials","url":"\/documentation\/auth0\/credentials","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","url":"\/documentation\/auth0\/webautherror\/usercancelled","type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","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},{"text":".","type":"text"}],"kind":"symbol","title":"userCancelled"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"callback"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" ("},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Callback that receives a ","type":"text"},{"code":"Result","type":"codeVoice"},{"text":" containing either the user’s credentials or an error.","type":"text"}]}],"name":"callback"}],"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)\")"," }","}"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","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 "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"reference","isActive":true},{"type":"text","text":" error."}],"type":"paragraph"},{"style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"text":"Callback URL","type":"text"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"text":"Allowed Callback URLs","type":"text"}],"type":"strong"},{"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},{"type":"text","text":"."}]}],"name":"Requires"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start(_:)"]}],"kind":"symbol","sections":[],"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","required":true,"title":"start(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"((","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"role":"symbol","externalID":"s:5Auth07WebAuthP5startyyys6ResultOyAA11CredentialsCAA0bC5ErrorVGcF","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","title":"userCancelled","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","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","isActive":true,"type":"reference"},{"text":".","type":"text"}]},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","url":"\/documentation\/auth0\/webauthresult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","role":"symbol","title":"WebAuthResult","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"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"},{"text":")","kind":"text"}],"required":true,"url":"\/documentation\/auth0\/webauth\/start(_:)","abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"title":"start(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"type":"topic","fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials","role":"symbol","title":"Credentials"}}} \ 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 7381fd3f..8fa9fe81 100644 --- a/docs/data/documentation/auth0/webauth/state(_:).json +++ b/docs/data/documentation/auth0/webauth/state(_:).json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"state","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"state"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"state","content":[{"inlineContent":[{"type":"text","text":"State value."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Specify a "},{"code":"state","type":"codeVoice"},{"type":"text","text":" parameter that will be sent back after authentication to verify that the response"},{"type":"text","text":" "},{"text":"corresponds to your request.","type":"text"},{"type":"text","text":" "},{"text":"By default a random value is used.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/state(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)"},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP5stateyxSSF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"state"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"state(_:)","symbolKind":"method","role":"symbol","required":true,"roleHeading":"Instance Method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"state"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"title":"state(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/state(_:)","type":"topic","abstract":[{"type":"text","text":"Specify a "},{"code":"state","type":"codeVoice"},{"type":"text","text":" parameter that will be sent back after authentication to verify that the response"},{"text":" ","type":"text"},{"type":"text","text":"corresponds to your request."},{"text":" ","type":"text"},{"type":"text","text":"By default a random value is used."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"state","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"state"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"state","content":[{"inlineContent":[{"type":"text","text":"State value."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/state(_:)"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"title":"state(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"state","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP5stateyxSSF","modules":[{"name":"Auth0"}],"required":true,"roleHeading":"Instance Method","symbolKind":"method","role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Specify a ","type":"text"},{"code":"state","type":"codeVoice"},{"type":"text","text":" parameter that will be sent back after authentication to verify that the response"},{"type":"text","text":" "},{"text":"corresponds to your request.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"By default a random value is used."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"state"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true,"url":"\/documentation\/auth0\/webauth\/state(_:)","abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"state"},{"type":"text","text":" parameter that will be sent back after authentication to verify that the response"},{"type":"text","text":" "},{"text":"corresponds to your request.","type":"text"},{"type":"text","text":" "},{"text":"By default a random value is used.","type":"text"}],"title":"state(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 3609aae1..47343b45 100644 --- a/docs/data/documentation/auth0/webauth/telemetry.json +++ b/docs/data/documentation/auth0/webauth/telemetry.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/webauth\/telemetry"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","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\/telemetry"},"sections":[],"abstract":[{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference","isActive":true},{"type":"text","text":" instance."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"kind":"text","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":" "},{"kind":"keyword","text":"set"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth07WebAuthP9telemetryAA9TelemetryVvp","role":"symbol","title":"telemetry","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry","kind":"typeIdentifier"}],"required":true},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","title":"Telemetry"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"}],"title":"telemetry","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","required":true,"url":"\/documentation\/auth0\/webauth\/telemetry","type":"topic","abstract":[{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"telemetry"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","text":"Telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"text":"set","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"abstract":[{"type":"text","text":"The "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference"},{"type":"text","text":" instance."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"symbolKind":"property","externalID":"s:5Auth07WebAuthP9telemetryAA9TelemetryVvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"telemetry","required":true,"roleHeading":"Instance Property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/telemetry"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}],"required":true,"url":"\/documentation\/auth0\/webauth\/telemetry","abstract":[{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference","isActive":true},{"text":" instance.","type":"text"}],"title":"telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"role":"symbol","url":"\/documentation\/auth0\/telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"title":"Telemetry"}}} \ 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 588607f5..48227564 100644 --- a/docs/data/documentation/auth0/webauth/url.json +++ b/docs/data/documentation/auth0/webauth/url.json @@ -1 +1 @@ -{"metadata":{"required":true,"title":"url","modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"roleHeading":"Instance Property","externalID":"s:5Auth07WebAuthP3url10Foundation3URLVvp"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/url"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"required":true,"title":"url","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/url","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"abstract":[{"type":"text","text":"The Auth0 Domain URL."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/url"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"url","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}],"externalID":"s:5Auth07WebAuthP3url10Foundation3URLVvp","required":true,"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"role":"symbol","title":"url","url":"\/documentation\/auth0\/webauth\/url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"required":true,"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"}}} \ 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 8fcddb00..dee689ae 100644 --- a/docs/data/documentation/auth0/webauth/useephemeralsession().json +++ b/docs/data/documentation/auth0/webauth/useephemeralsession().json @@ -1 +1 @@ -{"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\/useEphemeralSession()"},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"type":"aside","name":"Important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","isActive":true},{"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"}]}],"style":"important"},{"name":"Note","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","isActive":true},{"text":". Use either one or the other, because this","type":"text"},{"type":"text","text":" "},{"text":"method will only work with the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","required":true,"title":"useEphemeralSession()","externalID":"s:5Auth07WebAuthP19useEphemeralSessionxyF","role":"symbol","symbolKind":"method"},"abstract":[{"type":"text","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)."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/useephemeralsession()"]}],"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"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"type":"topic","url":"\/documentation\/auth0\/useragents","kind":"article","role":"article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[]},"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","title":"FAQ","titleInlineContent":[{"text":"FAQ","type":"text"}],"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"topic","title":"provider(_:)"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","titleInlineContent":[{"type":"text","text":"prefersEphemeralWebBrowserSession"}],"title":"prefersEphemeralWebBrowserSession"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","type":"topic","title":"clearSession(federated:callback:)","kind":"symbol","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"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","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","title":"useEphemeralSession()","kind":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"style":"important","content":[{"inlineContent":[{"text":"You don’t need to call ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","type":"reference"},{"type":"text","text":" if you are using this"},{"type":"text","text":" "},{"type":"text","text":"method on login, because there will be no shared cookie to remove."}],"type":"paragraph"}],"type":"aside","name":"Important"},{"name":"Note","type":"aside","style":"note","content":[{"inlineContent":[{"text":"Don’t use this method along with ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","isActive":true},{"type":"text","text":". Use either one or the other, because this"},{"text":" ","type":"text"},{"text":"method will only work with the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"type":"paragraph"}]}]}],"kind":"symbol","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"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webauth\/useephemeralsession()"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"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"}],"metadata":{"externalID":"s:5Auth07WebAuthP19useEphemeralSessionxyF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"required":true,"symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","title":"useEphemeralSession()","roleHeading":"Instance Method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"type":"topic","url":"\/documentation\/auth0\/webauth","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","title":"WebAuth","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"title":"provider(_:)","url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","role":"symbol","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"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"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"text":" ","type":"text"},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/useephemeralsession()"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/useragents"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"title":"prefersEphemeralWebBrowserSession","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","type":"link","titleInlineContent":[{"text":"prefersEphemeralWebBrowserSession","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"title":"clearSession(federated:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","type":"topic","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol"},"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"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","titleInlineContent":[{"text":"FAQ","type":"text"}]}}} \ 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 b68f8c4d..2ae3cadd 100644 --- a/docs/data/documentation/auth0/webauth/usehttps().json +++ b/docs/data/documentation/auth0/webauth/usehttps().json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Use "},{"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"},{"type":"text","text":" "},{"text":"macOS, the bundle identifier of the app will be used as a custom scheme.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useHTTPS"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}]}]},{"content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An Associated Domain configured with the "},{"type":"codeVoice","code":"webcredentials"},{"text":" service type. For example,","type":"text"},{"text":" ","type":"text"},{"code":"webcredentials:example.com","type":"codeVoice"},{"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":"aside"},{"name":"Note","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","isActive":true},{"text":". Use either one or the other, because this","type":"text"},{"text":" ","type":"text"},{"text":"method will only work with the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" implementation.","type":"text"}]}],"type":"aside"}],"kind":"content"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/usehttps()"]}],"metadata":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP8useHTTPSxyF","title":"useHTTPS()"},"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\/useHTTPS()","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"topic","title":"provider(_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useHTTPS","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"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."}],"url":"\/documentation\/auth0\/webauth\/usehttps()","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","title":"useHTTPS()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"type":"topic","abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuth"}]}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An Associated Domain configured with the "},{"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"},{"text":" ","type":"text"},{"type":"text","text":"Associated Domain. Otherwise, use the domain of your Auth0 tenant."}]}],"name":"Requires","type":"aside"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"reference","isActive":true},{"text":". Use either one or the other, because this","type":"text"},{"type":"text","text":" "},{"type":"text","text":"method will only work with the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}]}],"name":"Note","type":"aside"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","title":"useHTTPS()","roleHeading":"Instance Method","required":true,"symbolKind":"method","externalID":"s:5Auth07WebAuthP8useHTTPSxyF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useHTTPS","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webauth\/usehttps()"],"traits":[{"interfaceLanguage":"swift"}]}],"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"},{"type":"text","text":" "},{"type":"text","text":"macOS, the bundle identifier of the app will be used as a custom scheme."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"role":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth","type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"title":"provider(_:)","url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","role":"symbol","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"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"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"title":"useHTTPS()","required":true,"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"},{"text":" ","type":"text"},{"type":"text","text":"macOS, the bundle identifier of the app will be used as a custom scheme."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/usehttps()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"useHTTPS","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthentication.json b/docs/data/documentation/auth0/webauthentication.json index 5187c639..b81851b7 100644 --- a/docs/data/documentation/auth0/webauthentication.json +++ b/docs/data/documentation/auth0/webauthentication.json @@ -1 +1 @@ -{"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"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthentication"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"title":"WebAuthentication","navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"symbolKind":"struct","modules":[{"name":"Auth0"}],"externalID":"s:5Auth017WebAuthenticationV","role":"symbol"},"abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" as the external user agent."}],"kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"safariProvider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider","kind":"typeIdentifier"}],"title":"safariProvider(style:)","url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"topic","title":"provider(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"resume"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","title":"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":" "},{"type":"text","text":"custom scheme."}],"url":"\/documentation\/auth0\/webauthentication\/resume(with:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"role":"symbol","kind":"symbol","abstract":[{"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.","type":"text"}],"title":"cancel()","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"cancel"},{"text":"()","kind":"text"}],"url":"\/documentation\/auth0\/webauthentication\/cancel()","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"role":"symbol","navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication"}}} \ No newline at end of file +{"metadata":{"title":"WebAuthentication","externalID":"s:5Auth017WebAuthenticationV","role":"symbol","roleHeading":"Structure","modules":[{"name":"Auth0"}],"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthentication","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"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"}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthentication","kind":"identifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"variants":[{"paths":["\/documentation\/auth0\/webauthentication"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"WebAuthentication","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"type":"topic","url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","title":"safariProvider(style:)","abstract":[{"text":"Creates a Web Auth provider that uses ","type":"text"},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" as the external user agent."}],"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"title":"provider(_:)","url":"\/documentation\/auth0\/webauth\/provider(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","role":"symbol","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"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"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"type":"topic","url":"\/documentation\/auth0\/webauthentication\/resume(with:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","title":"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":" "},{"type":"text","text":"custom scheme."}],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"resume","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"type":"topic","url":"\/documentation\/auth0\/webauthentication\/cancel()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","title":"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":" "},{"text":"cancelled by the user.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"cancel","kind":"identifier"},{"text":"()","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"}}} \ 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 4fbfdddf..0c3c5d25 100644 --- a/docs/data/documentation/auth0/webauthentication/cancel().json +++ b/docs/data/documentation/auth0/webauthentication/cancel().json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"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":" "},{"text":"cancelled by the user.","type":"text"}],"metadata":{"role":"symbol","title":"cancel()","modules":[{"name":"Auth0"}],"externalID":"s:5Auth017WebAuthenticationV6cancelyyFZ","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"kind":"text","text":"()"}],"symbolKind":"method","roleHeading":"Type Method"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/cancel()"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"text":"()","kind":"text"}],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"role":"symbol","kind":"symbol","abstract":[{"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.","type":"text"}],"title":"cancel()","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"cancel"},{"text":"()","kind":"text"}],"url":"\/documentation\/auth0\/webauthentication\/cancel()","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"role":"symbol","navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"text":"()","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"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":" "},{"text":"cancelled by the user.","type":"text"}],"metadata":{"roleHeading":"Type Method","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"kind":"text","text":"()"}],"externalID":"s:5Auth017WebAuthenticationV6cancelyyFZ","title":"cancel()","role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/cancel()"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"type":"topic","url":"\/documentation\/auth0\/webauthentication\/cancel()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","title":"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":" "},{"text":"cancelled by the user.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"cancel","kind":"identifier"},{"text":"()","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"WebAuthentication","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ 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 71b18064..3b77f4f6 100644 --- a/docs/data/documentation/auth0/webauthentication/resume(with:).json +++ b/docs/data/documentation/auth0/webauthentication/resume(with:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"@discardableResult","kind":"attribute"},{"kind":"text","text":" "},{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}]},{"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"}]}]},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"If the URL was expected and properly formatted."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"level":3,"anchor":"For-UIKit-app-lifecycle","text":"For UIKit app lifecycle","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"In your "},{"type":"codeVoice","code":"AppDelegate.swift"},{"text":":","type":"text"}]},{"code":["func application(_ app: UIApplication,"," open url: URL,"," options: [UIApplication.OpenURLOptionsKey: Any]) -> Bool {"," return WebAuthentication.resume(with: url)","}"],"type":"codeListing","syntax":"swift"},{"type":"heading","level":3,"text":"For UIKit app lifecycle with Scenes","anchor":"For-UIKit-app-lifecycle-with-Scenes"},{"type":"paragraph","inlineContent":[{"text":"In your ","type":"text"},{"code":"SceneDelegate.swift","type":"codeVoice"},{"text":":","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["func scene(_ scene: UIScene, openURLContexts URLContexts: Set) {"," guard let url = URLContexts.first?.url else { return }"," WebAuthentication.resume(with: url)","}"]},{"anchor":"For-SwiftUI-app-lifecycle","text":"For SwiftUI app lifecycle","type":"heading","level":3},{"syntax":"swift","type":"codeListing","code":["SomeView()"," .onOpenURL { url in"," WebAuthentication.resume(with: url)"," }"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/resume(with:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"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"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"resume","kind":"identifier"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"symbolKind":"method","roleHeading":"Type Method","title":"resume(with:)","externalID":"s:5Auth017WebAuthenticationV6resume4withSb10Foundation3URLV_tFZ"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"role":"symbol","navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"resume"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","title":"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":" "},{"type":"text","text":"custom scheme."}],"url":"\/documentation\/auth0\/webauthentication\/resume(with:)"}}} \ No newline at end of file +{"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"},{"text":"custom scheme.","type":"text"}],"metadata":{"role":"symbol","symbolKind":"method","roleHeading":"Type Method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth017WebAuthenticationV6resume4withSb10Foundation3URLV_tFZ","title":"resume(with:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"resume"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/resume(with:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)"},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"attribute","text":"@discardableResult"},{"text":" ","kind":"text"},{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"resume","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"text":" ","kind":"text"},{"text":"url","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"]}],"kind":"declarations"},{"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":"parameters"},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"If the URL was expected and properly formatted.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"level":3,"text":"For UIKit app lifecycle","anchor":"For-UIKit-app-lifecycle","type":"heading"},{"inlineContent":[{"type":"text","text":"In your "},{"type":"codeVoice","code":"AppDelegate.swift"},{"text":":","type":"text"}],"type":"paragraph"},{"code":["func application(_ app: UIApplication,"," open url: URL,"," options: [UIApplication.OpenURLOptionsKey: Any]) -> Bool {"," return WebAuthentication.resume(with: url)","}"],"type":"codeListing","syntax":"swift"},{"anchor":"For-UIKit-app-lifecycle-with-Scenes","level":3,"type":"heading","text":"For UIKit app lifecycle with Scenes"},{"type":"paragraph","inlineContent":[{"text":"In your ","type":"text"},{"type":"codeVoice","code":"SceneDelegate.swift"},{"text":":","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["func scene(_ scene: UIScene, openURLContexts URLContexts: Set) {"," guard let url = URLContexts.first?.url else { return }"," WebAuthentication.resume(with: url)","}"]},{"text":"For SwiftUI app lifecycle","level":3,"type":"heading","anchor":"For-SwiftUI-app-lifecycle"},{"code":["SomeView()"," .onOpenURL { url in"," WebAuthentication.resume(with: url)"," }"],"syntax":"swift","type":"codeListing"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"WebAuthentication","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"type":"topic","url":"\/documentation\/auth0\/webauthentication\/resume(with:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","title":"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":" "},{"type":"text","text":"custom scheme."}],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"resume","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol"}}} \ 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 8d1146a6..c77574d2 100644 --- a/docs/data/documentation/auth0/webauthentication/safariprovider(style:).json +++ b/docs/data/documentation/auth0/webauthentication/safariprovider(style:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/safariprovider(style:)"]}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"safariProvider","kind":"identifier"},{"kind":"text","text":"("},{"text":"style","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UIModalPresentationStyle","kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"kind":"text","text":" = .fullScreen) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"UIModalPresentationStyle"},{"type":"text","text":" to be used. Defaults to "},{"type":"codeVoice","code":".fullScreen"},{"type":"text","text":"."}]}],"name":"style"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"text":"A ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","isActive":true},{"type":"text","text":" instance."}],"type":"paragraph"}]},{"content":[{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"type":"codeListing","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ...","}"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"If you need to specify a custom ","type":"text"},{"code":"UIModalPresentationStyle","type":"codeVoice"},{"text":":","type":"text"}]},{"code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider(style: .formSheet))"," .start { result in"," \/\/ ...","}"],"type":"codeListing","syntax":"swift"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","interfaceLanguage":"swift"},"sections":[],"metadata":{"externalID":"s:5Auth017WebAuthenticationV14safariProvider5styleAA0B13AuthUserAgent_p10Foundation3URLV_ys6ResultOyytAA0bG5ErrorVGctcSo24UIModalPresentationStyleV_tFZ","roleHeading":"Type Method","extendedModule":"Auth0","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"safariProvider","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"text":") -> ","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"modules":[{"name":"Auth0"}],"title":"safariProvider(style:)","symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"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/WebAuthentication/safariProvider(style:)":{"abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" as the external user agent."}],"kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"safariProvider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider","kind":"typeIdentifier"}],"title":"safariProvider(style:)","url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"type":"topic","url":"\/documentation\/auth0\/useragents","kind":"article","role":"article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"role":"symbol","navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"kind":"symbol","abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"type":"text","text":" to perform a web-based operation."},{"text":" ","type":"text"},{"type":"text","text":"The "},{"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."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]}}} \ 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\/WebAuthentication"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"]}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth017WebAuthenticationV14safariProvider5styleAA0B13AuthUserAgent_p10Foundation3URLV_ys6ResultOyytAA0bG5ErrorVGctcSo24UIModalPresentationStyleV_tFZ","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"safariProvider","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider","kind":"typeIdentifier"}],"title":"safariProvider(style:)","extendedModule":"Auth0","roleHeading":"Type Method","symbolKind":"method"},"abstract":[{"text":"Creates a Web Auth provider that uses ","type":"text"},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" as the external user agent."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"safariProvider","kind":"identifier"},{"kind":"text","text":"("},{"text":"style","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"text":" = .fullScreen) -> ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"}]}],"kind":"declarations"},{"parameters":[{"name":"style","content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"UIModalPresentationStyle"},{"type":"text","text":" to be used. Defaults to "},{"type":"codeVoice","code":".fullScreen"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"},{"type":"text","text":" instance."}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ...","}"]},{"inlineContent":[{"type":"text","text":"If you need to specify a custom "},{"code":"UIModalPresentationStyle","type":"codeVoice"},{"text":":","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider(style: .formSheet))"," .start { result in"," \/\/ ...","}"],"type":"codeListing"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/safariprovider(style:)"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"type":"topic","url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","title":"safariProvider(style:)","abstract":[{"text":"Creates a Web Auth provider that uses ","type":"text"},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" as the external user agent."}],"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"role":"article","type":"topic","url":"\/documentation\/auth0\/useragents"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"WebAuthentication","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference"},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProvider","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"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 4bf3663f..e73cde0e 100644 --- a/docs/data/documentation/auth0/webautherror.json +++ b/docs/data/documentation/auth0/webautherror.json @@ -1 +1 @@ -{"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"}],"topicSections":[{"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd"]},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription"]},{"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":"Type Properties"},{"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,"title":"Default Implementations"}],"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"role":"symbol","externalID":"s:5Auth012WebAuthErrorV","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"symbolKind":"struct","title":"WebAuthError","modules":[{"name":"Auth0"}]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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"},{"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"},{"text":".","type":"text"}],"kind":"symbol","title":"noBundleIdentifier","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"url":"\/documentation\/auth0\/webautherror\/nobundleidentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","type":"topic"},"https://manage.auth0.com/#/applications/":{"titleInlineContent":[{"text":"Auth0 application","type":"text"}],"title":"Auth0 application","type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","role":"collectionGroup","abstract":[],"kind":"article"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","role":"symbol","title":"noAuthorizationCode","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,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noAuthorizationCode","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"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"},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true,"type":"reference"},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"by setting the "},{"type":"strong","inlineContent":[{"text":"Application Type","type":"text"}]},{"text":" to ‘Native’.","type":"text"},{"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"}],"type":"topic","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","kind":"symbol","role":"symbol","title":"pkceNotAllowed","url":"\/documentation\/auth0\/webautherror\/pkcenotallowed"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"other","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"kind":"symbol","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webautherror\/other","title":"other","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 "},{"type":"codeVoice","code":"Error"},{"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"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"title":"debugDescription","abstract":[{"type":"text","text":"Description of the error."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/debugdescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"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"},{"text":"Auth0Error","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","type":"topic","title":"Auth0Error","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"title":"cause","url":"\/documentation\/auth0\/webautherror\/cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","kind":"symbol"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"abstract":[],"type":"topic","title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","url":"\/documentation\/auth0\/webautherror\/usercancelled","type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","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},{"text":".","type":"text"}],"kind":"symbol","title":"userCancelled"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"abstract":[],"type":"topic","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations","role":"collectionGroup","title":"Auth0Error Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"role":"symbol","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","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 "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"type":"topic","title":"idTokenValidationFailed","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"role":"symbol","abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","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:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","title":"~=(_:_:)","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"WebAuthError"},{"type":"text","text":" values in a switch statement."}],"title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"role":"symbol","url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","title":"invalidInvitationURL","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invalidInvitationURL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","kind":"symbol","abstract":[{"type":"text","text":"The invitation URL is missing the "},{"code":"invitation","type":"codeVoice"},{"type":"text","text":" and\/or the "},{"code":"organization","type":"codeVoice"},{"text":" query parameters.","type":"text"},{"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"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"kind":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"type":"codeVoice","code":"Error"},{"text":" value is not available.","type":"text"},{"type":"text","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":"."}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"unknown"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"title":"unknown","url":"\/documentation\/auth0\/webautherror\/unknown"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"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"},{"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":"Type Properties"},{"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,"title":"Default Implementations"}],"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"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"WebAuthError","roleHeading":"Structure","externalID":"s:5Auth012WebAuthErrorV","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"symbolKind":"struct","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"title":"~=(_:_:)","abstract":[{"text":"Matches ","type":"text"},{"code":"WebAuthError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"abstract":[{"text":"The bundle identifier could not be retrieved from ","type":"text"},{"type":"codeVoice","code":"Bundle.main.bundleIdentifier"},{"text":", or it could not be used to","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"build a valid URL."},{"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"},{"type":"text","text":"."}],"role":"symbol","title":"noBundleIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webautherror\/nobundleidentifier"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"abstract":[],"type":"topic","title":"Equatable Implementations","role":"collectionGroup","kind":"article","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"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","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"title":"idTokenValidationFailed","abstract":[{"type":"text","text":"The ID token validation performed after authentication failed."},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value 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."}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","title":"LocalizedError Implementations","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","type":"topic","kind":"article","role":"collectionGroup","abstract":[],"title":"Auth0Error Implementations","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"title":"unknown","abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is not available."},{"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/unknown","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"title":"invalidInvitationURL","kind":"symbol","abstract":[{"text":"The invitation URL is missing the ","type":"text"},{"code":"invitation","type":"codeVoice"},{"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"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invalidInvitationURL","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl"},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webautherror\/other","title":"other","abstract":[{"text":"An unexpected error occurred, and an ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"other"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"title":"cause","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","role":"symbol","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"}],"url":"\/documentation\/auth0\/webautherror\/cause","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","role":"symbol","title":"pkceNotAllowed","url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pkceNotAllowed","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"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\/","type":"reference","isActive":true},{"text":",","type":"text"},{"type":"text","text":" "},{"text":"by setting the ","type":"text"},{"inlineContent":[{"text":"Application Type","type":"text"}],"type":"strong"},{"text":" to ‘Native’.","type":"text"},{"type":"text","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":"."}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"title":"Auth0Error","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"url":"\/documentation\/auth0\/auth0error","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"debugDescription","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/webautherror\/debugdescription"},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Auth0 application","type":"link","titleInlineContent":[{"text":"Auth0 application","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","title":"userCancelled","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","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","isActive":true,"type":"reference"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"title":"noAuthorizationCode","abstract":[{"text":"The callback URL is missing the ","type":"text"},{"code":"code","type":"codeVoice"},{"text":" query parameter.","type":"text"},{"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","fragments":[{"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","kind":"typeIdentifier"}],"kind":"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 8115d7b7..7308fbd2 100644 --- a/docs/data/documentation/auth0/webautherror/!=(_:_:).json +++ b/docs/data/documentation/auth0/webautherror/!=(_:_:).json @@ -1 +1 @@ -{"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)"},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"roleHeading":"Operator","symbolKind":"op","title":"!=(_:_:)","role":"symbol","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth012WebAuthErrorV","extendedModule":"Swift"},"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"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"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":"Self"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","abstract":[],"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":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"type":"topic","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","role":"collectionGroup","abstract":[],"kind":"article"}}} \ 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"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)"},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"]}]}],"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webautherror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Operator","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"extendedModule":"Swift","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"!=(_:_:)","role":"symbol","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth012WebAuthErrorV","symbolKind":"op"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"abstract":[],"type":"topic","title":"Equatable Implementations","role":"collectionGroup","kind":"article","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","abstract":[],"title":"!=(_:_:)","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"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"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","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 bdb36fe7..6d91053d 100644 --- a/docs/data/documentation/auth0/webautherror/==(_:_:).json +++ b/docs/data/documentation/auth0/webautherror/==(_:_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}]}],"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":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/==(_:_:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","interfaceLanguage":"swift"},"metadata":{"title":"==(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:5Auth012WebAuthErrorV2eeoiySbAC_ACtFZ","role":"symbol","symbolKind":"op","modules":[{"name":"Auth0"}],"roleHeading":"Operator","extendedModule":"Auth0"},"kind":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","role":"collectionGroup","abstract":[],"kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"type":"topic","title":"==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","url":"\/documentation\/auth0\/webautherror\/==(_:_:)","role":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Operator","symbolKind":"op","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth012WebAuthErrorV2eeoiySbAC_ACtFZ","role":"symbol","title":"==(_:_:)","extendedModule":"Auth0"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","interfaceLanguage":"swift"},"abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"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"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"abstract":[],"type":"topic","title":"Equatable Implementations","role":"collectionGroup","kind":"article","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"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"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/webautherror\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"title":"==(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","kind":"symbol"}}} \ 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 534525e4..2ae93ec9 100644 --- a/docs/data/documentation/auth0/webautherror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/webautherror/auth0error-implementations.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/auth0error-implementations"]}],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription"],"generated":true,"title":"Instance Properties"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"metadata":{"title":"Auth0Error Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/errordescription","role":"symbol","title":"errorDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"kind":"symbol","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/localizeddescription"}}} \ 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\/WebAuthError"]]},"sections":[],"metadata":{"role":"collectionGroup","title":"Auth0Error Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription"],"generated":true}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/auth0error-implementations"]}],"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","type":"topic","kind":"symbol","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"title":"localizedDescription","url":"\/documentation\/auth0\/webautherror\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"role":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/webautherror\/errordescription","abstract":[{"type":"text","text":"Description of the error."}],"title":"errorDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"}}} \ 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 0480c3c7..6e03d3ef 100644 --- a/docs/data/documentation/auth0/webautherror/cause.json +++ b/docs/data/documentation/auth0/webautherror/cause.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"title":"cause","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth012WebAuthErrorV5causes0D0_pSgvp","symbolKind":"property"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","interfaceLanguage":"swift"},"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":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/cause"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":"?"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"title":"cause","url":"\/documentation\/auth0\/webautherror\/cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth012WebAuthErrorV5causes0D0_pSgvp","title":"cause","role":"symbol","symbolKind":"property"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"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"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}],"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\/cause"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"title":"cause","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","role":"symbol","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"}],"url":"\/documentation\/auth0\/webautherror\/cause","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"}}} \ 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 2ff1036e..0ef1a861 100644 --- a/docs/data/documentation/auth0/webautherror/debugdescription.json +++ b/docs/data/documentation/auth0/webautherror/debugdescription.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}]},{"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":[{"text":"debugging","type":"text"}]},{"type":"text","text":" only."}]}],"style":"important","type":"aside"}],"kind":"content"}],"abstract":[{"text":"Description of the error.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"title":"debugDescription","modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"externalID":"s:5Auth012WebAuthErrorV16debugDescriptionSSvp","roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription"},"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/debugdescription"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"title":"debugDescription","abstract":[{"type":"text","text":"Description of the error."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/debugdescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]}}} \ No newline at end of file +{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"metadata":{"roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"debugDescription","externalID":"s:5Auth012WebAuthErrorV16debugDescriptionSSvp"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/debugdescription"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"type":"aside","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"}]},{"type":"text","text":" only."}]}],"style":"important"}]}],"abstract":[{"type":"text","text":"Description of the error."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"debugDescription","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/webautherror\/debugdescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"}}} \ 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 e152fcc7..5bd36d96 100644 --- a/docs/data/documentation/auth0/webautherror/equatable-implementations.json +++ b/docs/data/documentation/auth0/webautherror/equatable-implementations.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"},"topicSections":[{"title":"Operators","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"role":"collectionGroup","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"Equatable Implementations"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"article","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/equatable-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"type":"topic","title":"==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","url":"\/documentation\/auth0\/webautherror\/==(_:_:)","role":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","abstract":[],"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":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"type":"topic","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]}}} \ No newline at end of file +{"sections":[],"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Equatable Implementations"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)"],"generated":true}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"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"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/webautherror\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"title":"==(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","abstract":[],"title":"!=(_:_:)","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"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"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"}}} \ 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 5eae6655..55caaddd 100644 --- a/docs/data/documentation/auth0/webautherror/errordescription.json +++ b/docs/data/documentation/auth0/webautherror/errordescription.json @@ -1 +1 @@ -{"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":[],"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"name":"Important","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":[{"text":"debugging","type":"text"}]},{"type":"text","text":" only."}]}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"errorDescription","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"extendedModule":"Auth0","roleHeading":"Instance Property"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webautherror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/errordescription","role":"symbol","title":"errorDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"abstract":[],"type":"topic","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations","role":"collectionGroup","title":"Auth0Error Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}]},{"content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"style":"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","name":"Important"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription"},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"]]},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","symbolKind":"property","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":"?"}],"title":"errorDescription","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","roleHeading":"Instance Property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/errordescription"]}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"role":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/webautherror\/errordescription","abstract":[{"type":"text","text":"Description of the error."}],"title":"errorDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","type":"topic","kind":"article","role":"collectionGroup","abstract":[],"title":"Auth0Error Implementations","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 b5229e4d..85d32040 100644 --- a/docs/data/documentation/auth0/webautherror/failurereason.json +++ b/docs/data/documentation/auth0/webautherror/failurereason.json @@ -1 +1 @@ -{"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"type":"text","text":"."}],"metadata":{"extendedModule":"Foundation","role":"symbol","platforms":[{"unavailable":false,"introducedAt":"8.0","name":"iOS","deprecated":false,"beta":false},{"unavailable":false,"beta":false,"introducedAt":"10.10","name":"macOS","deprecated":false},{"name":"tvOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"9.0"},{"introducedAt":"2.0","unavailable":false,"name":"watchOS","deprecated":false,"beta":false}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"failureReason","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"property","roleHeading":"Instance Property"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/failurereason"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"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":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"failureReason","url":"\/documentation\/auth0\/webautherror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","type":"topic","role":"symbol","kind":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"abstract":[],"type":"topic","title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","role":"collectionGroup"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"extendedModule":"Foundation","role":"symbol","title":"failureReason","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"platforms":[{"unavailable":false,"deprecated":false,"introducedAt":"8.0","beta":false,"name":"iOS"},{"beta":false,"name":"macOS","unavailable":false,"deprecated":false,"introducedAt":"10.10"},{"deprecated":false,"unavailable":false,"introducedAt":"9.0","beta":false,"name":"tvOS"},{"introducedAt":"2.0","deprecated":false,"beta":false,"name":"watchOS","unavailable":false}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","roleHeading":"Instance Property","symbolKind":"property"},"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/failurereason"]}],"kind":"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"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"type":"topic","url":"\/documentation\/auth0\/webautherror\/failurereason","kind":"symbol","title":"failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","title":"LocalizedError Implementations","abstract":[],"role":"collectionGroup"}}} \ 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 48f299ee..15120b88 100644 --- a/docs/data/documentation/auth0/webautherror/helpanchor.json +++ b/docs/data/documentation/auth0/webautherror/helpanchor.json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor"},"schemaVersion":{"major":0,"minor":3,"patch":0},"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":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/helpanchor"]}],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","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"]}],"kind":"declarations"}],"kind":"symbol","metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"roleHeading":"Instance Property","extendedModule":"Foundation","role":"symbol","title":"helpAnchor","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":[{"name":"iOS","deprecated":false,"beta":false,"introducedAt":"8.0","unavailable":false},{"unavailable":false,"introducedAt":"10.10","beta":false,"name":"macOS","deprecated":false},{"deprecated":false,"name":"tvOS","beta":false,"unavailable":false,"introducedAt":"9.0"},{"introducedAt":"2.0","deprecated":false,"unavailable":false,"beta":false,"name":"watchOS"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"abstract":[],"type":"topic","title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","url":"\/documentation\/auth0\/webautherror\/helpanchor","title":"helpAnchor","kind":"symbol","abstract":[],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/webautherror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","interfaceLanguage":"swift"},"metadata":{"title":"helpAnchor","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","symbolKind":"property","extendedModule":"Foundation","role":"symbol","platforms":[{"name":"iOS","deprecated":false,"beta":false,"introducedAt":"8.0","unavailable":false},{"deprecated":false,"name":"macOS","unavailable":false,"introducedAt":"10.10","beta":false},{"name":"tvOS","deprecated":false,"introducedAt":"9.0","unavailable":false,"beta":false},{"deprecated":false,"name":"watchOS","unavailable":false,"introducedAt":"2.0","beta":false}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"roleHeading":"Instance Property"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","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"]]},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"type":"text","text":"."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","title":"LocalizedError Implementations","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webautherror\/helpanchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"helpAnchor","abstract":[],"role":"symbol"}}} \ 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 7e9116f2..c554f112 100644 --- a/docs/data/documentation/auth0/webautherror/idtokenvalidationfailed.json +++ b/docs/data/documentation/auth0/webautherror/idtokenvalidationfailed.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"The ID token validation performed after authentication failed.","type":"text"},{"text":" ","type":"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"},{"type":"text","text":" property."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"idTokenValidationFailed","roleHeading":"Type Property","externalID":"s:5Auth012WebAuthErrorV23idTokenValidationFailedACvpZ","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"symbolKind":"property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"idTokenValidationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"platforms":["iOS"],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","interfaceLanguage":"swift"},"sections":[],"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/idTokenValidationFailed":{"role":"symbol","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","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 "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"type":"topic","title":"idTokenValidationFailed","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"idTokenValidationFailed","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed"},"metadata":{"title":"idTokenValidationFailed","externalID":"s:5Auth012WebAuthErrorV23idTokenValidationFailedACvpZ","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Type Property"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"],"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\/WebAuthError"]]},"abstract":[{"text":"The ID token validation performed after authentication failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value 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":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"title":"idTokenValidationFailed","abstract":[{"type":"text","text":"The ID token validation performed after authentication failed."},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value 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."}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"}}} \ 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 fae0cb99..3afd24fa 100644 --- a/docs/data/documentation/auth0/webautherror/invalidinvitationurl.json +++ b/docs/data/documentation/auth0/webautherror/invalidinvitationurl.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"The invitation URL is missing the ","type":"text"},{"code":"invitation","type":"codeVoice"},{"type":"text","text":" and\/or the "},{"code":"organization","type":"codeVoice"},{"type":"text","text":" query parameters."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/invalidinvitationurl"]}],"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"invalidInvitationURL"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]}],"kind":"declarations"}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth012WebAuthErrorV20invalidInvitationURLACvpZ","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invalidInvitationURL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"roleHeading":"Type Property","symbolKind":"property","title":"invalidInvitationURL"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"role":"symbol","url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","title":"invalidInvitationURL","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invalidInvitationURL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","kind":"symbol","abstract":[{"type":"text","text":"The invitation URL is missing the "},{"code":"invitation","type":"codeVoice"},{"type":"text","text":" and\/or the "},{"code":"organization","type":"codeVoice"},{"text":" query parameters.","type":"text"},{"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"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"title":"invalidInvitationURL","externalID":"s:5Auth012WebAuthErrorV20invalidInvitationURLACvpZ","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"invalidInvitationURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"modules":[{"name":"Auth0"}],"roleHeading":"Type Property","role":"symbol","symbolKind":"property"},"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","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/invalidinvitationurl"]}],"abstract":[{"type":"text","text":"The invitation URL is missing the "},{"code":"invitation","type":"codeVoice"},{"text":" and\/or the ","type":"text"},{"code":"organization","type":"codeVoice"},{"text":" query parameters.","type":"text"},{"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"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"title":"invalidInvitationURL","kind":"symbol","abstract":[{"text":"The invitation URL is missing the ","type":"text"},{"code":"invitation","type":"codeVoice"},{"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"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invalidInvitationURL","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","type":"topic","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 ea88e33d..f4d77994 100644 --- a/docs/data/documentation/auth0/webautherror/localizeddescription.json +++ b/docs/data/documentation/auth0/webautherror/localizeddescription.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"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"},{"type":"text","text":" only."}],"type":"paragraph"}],"name":"Important"}]}],"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"property","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"extendedModule":"Auth0","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","modules":[{"name":"Auth0"}],"title":"localizedDescription","role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizeddescription"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"kind":"symbol","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"abstract":[],"type":"topic","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations","role":"collectionGroup","title":"Auth0Error Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizeddescription"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"]]},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","extendedModule":"Auth0","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","role":"symbol","symbolKind":"property","title":"localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","interfaceLanguage":"swift"},"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","type":"heading","level":2,"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":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}]}],"type":"aside","name":"Important"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","type":"topic","kind":"symbol","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"title":"localizedDescription","url":"\/documentation\/auth0\/webautherror\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","type":"topic","kind":"article","role":"collectionGroup","abstract":[],"title":"Auth0Error Implementations","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 a0532637..3c23a164 100644 --- a/docs/data/documentation/auth0/webautherror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/webautherror/localizederror-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"topicSections":[{"generated":true,"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"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"},"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizederror-implementations"]}],"metadata":{"modules":[{"name":"Auth0"}],"title":"LocalizedError Implementations","role":"collectionGroup","roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"abstract":[],"type":"topic","title":"recoverySuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","url":"\/documentation\/auth0\/webautherror\/helpanchor","title":"helpAnchor","kind":"symbol","abstract":[],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"failureReason","url":"\/documentation\/auth0\/webautherror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","type":"topic","role":"symbol","kind":"symbol","abstract":[]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"topicSections":[{"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,"title":"Instance Properties"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizederror-implementations"]}],"kind":"article","schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"metadata":{"role":"collectionGroup","title":"LocalizedError Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"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":"?"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","role":"symbol","abstract":[],"title":"recoverySuggestion","url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"type":"topic","url":"\/documentation\/auth0\/webautherror\/failurereason","kind":"symbol","title":"failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webautherror\/helpanchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"helpAnchor","abstract":[],"role":"symbol"}}} \ 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 584bda03..0a79805c 100644 --- a/docs/data/documentation/auth0/webautherror/noauthorizationcode.json +++ b/docs/data/documentation/auth0/webautherror/noauthorizationcode.json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError"}],"languages":["swift"]}]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"externalID":"s:5Auth012WebAuthErrorV19noAuthorizationCodeACvpZ","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Type Property","symbolKind":"property","title":"noAuthorizationCode","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noAuthorizationCode","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/noauthorizationcode"],"traits":[{"interfaceLanguage":"swift"}]}],"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"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","role":"symbol","title":"noAuthorizationCode","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,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noAuthorizationCode","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noAuthorizationCode"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"metadata":{"externalID":"s:5Auth012WebAuthErrorV19noAuthorizationCodeACvpZ","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"noAuthorizationCode"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"title":"noAuthorizationCode","role":"symbol","roleHeading":"Type Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The callback URL is missing the "},{"code":"code","type":"codeVoice"},{"type":"text","text":" query parameter."},{"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":"."}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/noauthorizationcode"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"title":"noAuthorizationCode","abstract":[{"text":"The callback URL is missing the ","type":"text"},{"code":"code","type":"codeVoice"},{"text":" query parameter.","type":"text"},{"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","fragments":[{"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","kind":"typeIdentifier"}],"kind":"symbol","type":"topic"}}} \ 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 249bda6b..874a0b79 100644 --- a/docs/data/documentation/auth0/webautherror/nobundleidentifier.json +++ b/docs/data/documentation/auth0/webautherror/nobundleidentifier.json @@ -1 +1 @@ -{"sections":[],"abstract":[{"text":"The bundle identifier could not be retrieved from ","type":"text"},{"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."},{"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":"."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/nobundleidentifier"]}],"metadata":{"symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV18noBundleIdentifierACvpZ","roleHeading":"Type Property","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"noBundleIdentifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"noBundleIdentifier"},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"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"},{"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"},{"text":".","type":"text"}],"kind":"symbol","title":"noBundleIdentifier","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"url":"\/documentation\/auth0\/webautherror\/nobundleidentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]}}} \ No newline at end of file +{"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"},{"text":" ","type":"text"},{"text":"build a valid URL.","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":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"metadata":{"roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol","title":"noBundleIdentifier","externalID":"s:5Auth012WebAuthErrorV18noBundleIdentifierACvpZ","symbolKind":"property","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/nobundleidentifier"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noBundleIdentifier","kind":"identifier"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"abstract":[{"text":"The bundle identifier could not be retrieved from ","type":"text"},{"type":"codeVoice","code":"Bundle.main.bundleIdentifier"},{"text":", or it could not be used to","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"build a valid URL."},{"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"},{"type":"text","text":"."}],"role":"symbol","title":"noBundleIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webautherror\/nobundleidentifier"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"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 2f8db04d..4d051f17 100644 --- a/docs/data/documentation/auth0/webautherror/other.json +++ b/docs/data/documentation/auth0/webautherror/other.json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"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","text":"WebAuthError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"}],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"externalID":"s:5Auth012WebAuthErrorV5otherACvpZ","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","symbolKind":"property","role":"symbol","title":"other","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"other","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/other"],"traits":[{"interfaceLanguage":"swift"}]}],"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 "},{"type":"codeVoice","code":"Error"},{"text":" value 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"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"other","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"kind":"symbol","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webautherror\/other","title":"other","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 "},{"type":"codeVoice","code":"Error"},{"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"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other"},"abstract":[{"text":"An unexpected error occurred, and an ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is available."},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"other","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"}]}]}],"metadata":{"role":"symbol","symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV5otherACvpZ","modules":[{"name":"Auth0"}],"title":"other","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"other"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webautherror\/other"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webautherror\/other","title":"other","abstract":[{"text":"An unexpected error occurred, and an ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"other"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other"}}} \ 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 65e7d93e..cbdc312b 100644 --- a/docs/data/documentation/auth0/webautherror/pkcenotallowed.json +++ b/docs/data/documentation/auth0/webautherror/pkcenotallowed.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]}],"kind":"declarations"}],"sections":[],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"pkceNotAllowed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV14pkceNotAllowedACvpZ","roleHeading":"Type Property","title":"pkceNotAllowed"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"abstract":[{"text":"The Auth0 application does not support authentication with Proof Key for Code Exchange (PKCE).","type":"text"},{"type":"text","text":" "},{"type":"text","text":"PKCE support needs to be enabled in the settings page of the "},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference","isActive":true},{"type":"text","text":","},{"type":"text","text":" "},{"text":"by setting the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Application Type","type":"text"}]},{"text":" to ‘Native’.","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},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/pkcenotallowed"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"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"},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true,"type":"reference"},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"by setting the "},{"type":"strong","inlineContent":[{"text":"Application Type","type":"text"}]},{"text":" to ‘Native’.","type":"text"},{"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"}],"type":"topic","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","kind":"symbol","role":"symbol","title":"pkceNotAllowed","url":"\/documentation\/auth0\/webautherror\/pkcenotallowed"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Auth0 application"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Auth0 application","type":"link"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/pkcenotallowed"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"pkceNotAllowed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"pkceNotAllowed","symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV14pkceNotAllowedACvpZ","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"pkceNotAllowed"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"roleHeading":"Type Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"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\/","type":"reference","isActive":true},{"text":",","type":"text"},{"text":" ","type":"text"},{"text":"by setting the ","type":"text"},{"inlineContent":[{"text":"Application Type","type":"text"}],"type":"strong"},{"text":" to ‘Native’.","type":"text"},{"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":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","role":"symbol","title":"pkceNotAllowed","url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pkceNotAllowed","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"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\/","type":"reference","isActive":true},{"text":",","type":"text"},{"type":"text","text":" "},{"text":"by setting the ","type":"text"},{"inlineContent":[{"text":"Application Type","type":"text"}],"type":"strong"},{"text":" to ‘Native’.","type":"text"},{"type":"text","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":"."}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"https://manage.auth0.com/#/applications/":{"type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"text":"Auth0 application","type":"text"}],"title":"Auth0 application"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"}}} \ 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 4f33b097..dd9dc27f 100644 --- a/docs/data/documentation/auth0/webautherror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/webautherror/recoverysuggestion.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"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"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","title":"recoverySuggestion","role":"symbol","symbolKind":"property","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"roleHeading":"Instance Property","platforms":[{"beta":false,"name":"iOS","unavailable":false,"introducedAt":"8.0","deprecated":false},{"unavailable":false,"beta":false,"introducedAt":"10.10","name":"macOS","deprecated":false},{"beta":false,"introducedAt":"9.0","unavailable":false,"name":"tvOS","deprecated":false},{"introducedAt":"2.0","name":"watchOS","beta":false,"deprecated":false,"unavailable":false}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"extendedModule":"Foundation"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"abstract":[],"type":"topic","title":"recoverySuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"abstract":[],"type":"topic","title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]]},"metadata":{"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"}],"role":"symbol","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","platforms":[{"deprecated":false,"name":"iOS","introducedAt":"8.0","unavailable":false,"beta":false},{"deprecated":false,"beta":false,"introducedAt":"10.10","name":"macOS","unavailable":false},{"name":"tvOS","unavailable":false,"beta":false,"deprecated":false,"introducedAt":"9.0"},{"deprecated":false,"name":"watchOS","beta":false,"unavailable":false,"introducedAt":"2.0"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","roleHeading":"Instance Property","title":"recoverySuggestion","symbolKind":"property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"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":"?"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","role":"symbol","abstract":[],"title":"recoverySuggestion","url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"kind":"article","type":"topic","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","title":"LocalizedError Implementations","abstract":[],"role":"collectionGroup"}}} \ 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 d854a30a..a61767e5 100644 --- a/docs/data/documentation/auth0/webautherror/unknown.json +++ b/docs/data/documentation/auth0/webautherror/unknown.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/unknown"]}],"sections":[],"kind":"symbol","abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value is not available.","type":"text"},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown"},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"unknown","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]}]}],"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"title":"unknown","role":"symbol","roleHeading":"Type Property","symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV7unknownACvpZ","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"kind":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"type":"codeVoice","code":"Error"},{"text":" value is not available.","type":"text"},{"type":"text","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":"."}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"unknown"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"title":"unknown","url":"\/documentation\/auth0\/webautherror\/unknown"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"roleHeading":"Type Property","symbolKind":"property","role":"symbol","title":"unknown","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"externalID":"s:5Auth012WebAuthErrorV7unknownACvpZ"},"kind":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"code":"Error","type":"codeVoice"},{"text":" value is not available.","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"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/unknown"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"title":"unknown","abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is not available."},{"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":"."}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/unknown","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"}}} \ 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 62f4f163..c0a0f64c 100644 --- a/docs/data/documentation/auth0/webautherror/usercancelled.json +++ b/docs/data/documentation/auth0/webautherror/usercancelled.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","metadata":{"symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"title":"userCancelled","externalID":"s:5Auth012WebAuthErrorV13userCancelledACvpZ","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Type Property"},"abstract":[{"text":"The user cancelled the Web Auth operation.","type":"text"},{"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":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/usercancelled"]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","url":"\/documentation\/auth0\/webautherror\/usercancelled","type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","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},{"text":".","type":"text"}],"kind":"symbol","title":"userCancelled"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"roleHeading":"Type Property","externalID":"s:5Auth012WebAuthErrorV13userCancelledACvpZ","role":"symbol","title":"userCancelled","symbolKind":"property"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},"abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"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":"."}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/usercancelled"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","title":"userCancelled","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","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","isActive":true,"type":"reference"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","title":"cause","kind":"symbol","role":"symbol","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"}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}}} \ 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 1dfdde5a..5e2378f7 100644 --- a/docs/data/documentation/auth0/webautherror/~=(_:_:)-3690.json +++ b/docs/data/documentation/auth0/webautherror/~=(_:_:)-3690.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError"},{"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":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-3690"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"modules":[{"name":"Auth0"}],"symbolKind":"op","extendedModule":"Auth0","externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_ACtFZ","roleHeading":"Operator","title":"~=(_:_:)"},"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"WebAuthError"},{"type":"text","text":" values in a switch statement."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","interfaceLanguage":"swift"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"WebAuthError"},{"type":"text","text":" values in a switch statement."}],"title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"]}]}],"sections":[],"metadata":{"externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_ACtFZ","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","symbolKind":"op","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"~=(_:_:)","role":"symbol","roleHeading":"Operator"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690"},"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"WebAuthError"},{"type":"text","text":" values in a switch statement."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-3690"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"title":"~=(_:_:)","abstract":[{"text":"Matches ","type":"text"},{"code":"WebAuthError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","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 1a9559bd..6494391c 100644 --- a/docs/data/documentation/auth0/webautherror/~=(_:_:)-6ibkd.json +++ b/docs/data/documentation/auth0/webautherror/~=(_:_:)-6ibkd.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"Error"},{"text":" values in a switch statement.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd"]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"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"},{"kind":"text","text":": "},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","metadata":{"role":"symbol","roleHeading":"Operator","modules":[{"name":"Auth0"}],"symbolKind":"op","externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_s0D0_ptFZ","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"~=(_:_:)","extendedModule":"Auth0"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"role":"symbol","abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","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:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","title":"~=(_:_:)","kind":"symbol","type":"topic"}}} \ No newline at end of file +{"abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"symbolKind":"op","externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_s0D0_ptFZ","title":"~=(_:_:)","modules":[{"name":"Auth0"}],"roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","extendedModule":"Auth0"},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"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","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthprovider.json b/docs/data/documentation/auth0/webauthprovider.json index cddacf09..4fb7c584 100644 --- a/docs/data/documentation/auth0/webauthprovider.json +++ b/docs/data/documentation/auth0/webauthprovider.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"symbolKind":"typealias","role":"symbol","title":"WebAuthProvider","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"WebAuthProvider","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProvider"}],"roleHeading":"Type Alias","externalID":"s:5Auth015WebAuthProvidera"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProvider","kind":"identifier"},{"kind":"text","text":" = ("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"url","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":", "},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"callback"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:5Auth023WebAuthProviderCallbacka","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","text":"WebAuthProviderCallback"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth016WebAuthUserAgentP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","text":"WebAuthUserAgent","kind":"typeIdentifier"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthprovider"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"},"kind":"symbol","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"},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"]}],"references":{"https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift":{"titleInlineContent":[{"text":"Example","type":"text"}],"title":"Example","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"}],"abstract":[{"text":"Callback invoked by the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" when the web-based operation concludes."}],"title":"WebAuthProviderCallback","kind":"symbol","url":"\/documentation\/auth0\/webauthprovidercallback","navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"kind":"symbol","abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"type":"text","text":" to perform a web-based operation."},{"text":" ","type":"text"},{"type":"text","text":"The "},{"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."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"type":"text","text":" to perform a web-based operation."},{"type":"text","text":" "},{"type":"text","text":"The "},{"isActive":true,"type":"reference","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."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"seeAlsoSections":[{"identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"],"title":"Related Documentation"}],"metadata":{"role":"symbol","roleHeading":"Type Alias","externalID":"s:5Auth015WebAuthProvidera","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"}],"symbolKind":"typealias","title":"WebAuthProvider","navigatorTitle":[{"text":"WebAuthProvider","kind":"identifier"}],"modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProvider","kind":"identifier"},{"text":" = (","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"url","kind":"internalParam"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":", ","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"callback"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"text":" ","kind":"text"},{"text":"WebAuthProviderCallback","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023WebAuthProviderCallbacka","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016WebAuthUserAgentP","text":"WebAuthUserAgent"}]}]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/webauthprovider"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"role":"symbol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}],"url":"\/documentation\/auth0\/webauthprovidercallback","title":"WebAuthProviderCallback","abstract":[{"type":"text","text":"Callback invoked by the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" when the web-based operation concludes.","type":"text"}],"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProviderCallback","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference"},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProvider","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"},"https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift":{"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","title":"Example","type":"link","titleInlineContent":[{"text":"Example","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthprovidercallback.json b/docs/data/documentation/auth0/webauthprovidercallback.json index 3db7639b..8f988a51 100644 --- a/docs/data/documentation/auth0/webauthprovidercallback.json +++ b/docs/data/documentation/auth0/webauthprovidercallback.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"Callback invoked by the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" when the web-based operation concludes.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProviderCallback"},{"text":" = (","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"}]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthprovidercallback"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback"},"metadata":{"roleHeading":"Type Alias","modules":[{"name":"Auth0"}],"externalID":"s:5Auth023WebAuthProviderCallbacka","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProviderCallback","kind":"identifier"}],"symbolKind":"typealias","title":"WebAuthProviderCallback","navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"}],"abstract":[{"text":"Callback invoked by the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" when the web-based operation concludes."}],"title":"WebAuthProviderCallback","kind":"symbol","url":"\/documentation\/auth0\/webauthprovidercallback","navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthprovidercallback"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"Callback invoked by the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"type":"text","text":" when the web-based operation concludes."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"},{"kind":"text","text":" = ("},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"}],"languages":["swift"]}]}],"metadata":{"role":"symbol","symbolKind":"typealias","navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}],"externalID":"s:5Auth023WebAuthProviderCallbacka","modules":[{"name":"Auth0"}],"title":"WebAuthProviderCallback","roleHeading":"Type Alias","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProviderCallback"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"role":"symbol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}],"url":"\/documentation\/auth0\/webauthprovidercallback","title":"WebAuthProviderCallback","abstract":[{"type":"text","text":"Callback invoked by the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" when the web-based operation concludes.","type":"text"}],"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthProviderCallback","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","url":"\/documentation\/auth0\/webauthresult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","role":"symbol","title":"WebAuthResult","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthresult.json b/docs/data/documentation/auth0/webauthresult.json index 62384c21..21dd43b8 100644 --- a/docs/data/documentation/auth0/webauthresult.json +++ b/docs/data/documentation/auth0/webauthresult.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO","text":"Result"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth013WebAuthResulta1Txmfp","text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError"},{"kind":"text","text":">"}]}],"kind":"declarations"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"metadata":{"modules":[{"name":"Auth0"}],"title":"WebAuthResult","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"externalID":"s:5Auth013WebAuthResulta","roleHeading":"Type Alias","symbolKind":"typealias","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/webauthresult"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","kind":"symbol","url":"\/documentation\/auth0\/webautherror","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webauthresult"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"preciseIdentifier":"s:s6ResultO","text":"Result","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth013WebAuthResulta1Txmfp"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},"metadata":{"symbolKind":"typealias","modules":[{"name":"Auth0"}],"externalID":"s:5Auth013WebAuthResulta","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"role":"symbol","title":"WebAuthResult","roleHeading":"Type Alias","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthResult","kind":"identifier"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","url":"\/documentation\/auth0\/webauthresult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","role":"symbol","title":"WebAuthResult","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"kind":"symbol","role":"symbol","title":"WebAuthError","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthuseragent.json b/docs/data/documentation/auth0/webauthuseragent.json index c4f6a6a4..13d69a43 100644 --- a/docs/data/documentation/auth0/webauthuseragent.json +++ b/docs/data/documentation/auth0/webauthuseragent.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/webauthuseragent"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"]}],"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]}]}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth016WebAuthUserAgentP","roleHeading":"Protocol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"symbolKind":"protocol","title":"WebAuthUserAgent","role":"symbol"},"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift":{"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","type":"link","titleInlineContent":[{"type":"text","text":"Example"}],"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","title":"Example"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"()"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","url":"\/documentation\/auth0\/webauthuseragent\/start()","type":"topic","abstract":[{"text":"Starts the external user agent.","type":"text"}],"required":true,"kind":"symbol","title":"start()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","abstract":[{"text":"Tears down the external user agent after the web-based operation completed, if needed.","type":"text"},{"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."}],"title":"finish(with:)","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/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":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">)"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"],"title":"Instance Methods"}],"metadata":{"role":"symbol","symbolKind":"protocol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"externalID":"s:5Auth016WebAuthUserAgentP","modules":[{"name":"Auth0"}],"title":"WebAuthUserAgent","roleHeading":"Protocol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}]},"seeAlsoSections":[{"identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/webauthuseragent"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"},"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","title":"Example","titleInlineContent":[{"type":"text","text":"Example"}],"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"title":"start()","required":true,"abstract":[{"text":"Starts the external user agent.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"()","kind":"text"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"finish","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">)"}],"url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","type":"topic","role":"symbol","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"},{"type":"text","text":" "},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"title":"finish(with:)"}}} \ 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 b20b10cd..c0f8f286 100644 --- a/docs/data/documentation/auth0/webauthuseragent/finish(with:).json +++ b/docs/data/documentation/auth0/webauthuseragent/finish(with:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"externalID":"s:5Auth016WebAuthUserAgentP6finish4withys6ResultOyytAA0bC5ErrorVG_tF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"finish","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">)"}],"role":"symbol","required":true,"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"finish(with:)"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"finish"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":" "},{"kind":"internalParam","text":"result"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":">)","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"name":"result","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"}]}],"kind":"parameters"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","interfaceLanguage":"swift"},"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"}]}],"kind":"symbol","abstract":[{"text":"Tears down the external user agent after the web-based operation completed, if needed.","type":"text"},{"type":"text","text":" "},{"text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user","type":"text"},{"type":"text","text":" "},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","abstract":[{"text":"Tears down the external user agent after the web-based operation completed, if needed.","type":"text"},{"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."}],"title":"finish(with:)","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/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":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">)"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]]},"kind":"symbol","metadata":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"finish"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">)"}],"externalID":"s:5Auth016WebAuthUserAgentP6finish4withys6ResultOyytAA0bC5ErrorVG_tF","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","title":"finish(with:)"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"finish","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"result"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">)"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"result","content":[{"inlineContent":[{"type":"text","text":"The outcome of the web-based operation, containing either an empty success case or an"},{"type":"text","text":" "},{"type":"text","text":"error."}],"type":"paragraph"}]}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/webauthuseragent\/finish(with:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Tears down the external user agent after the web-based operation completed, if needed.","type":"text"},{"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":" "},{"text":"cancelled the operation, or after any other error occurred.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"finish","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">)"}],"url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","type":"topic","role":"symbol","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"},{"type":"text","text":" "},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"title":"finish(with:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","url":"\/documentation\/auth0\/webauthresult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","role":"symbol","title":"WebAuthResult","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"}}} \ 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 36d7bb3b..bce7edaa 100644 --- a/docs/data/documentation/auth0/webauthuseragent/start().json +++ b/docs/data/documentation/auth0/webauthuseragent/start().json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"type":"text","text":"Starts the external user agent."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"()","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"title":"start()","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"()"}],"role":"symbol","required":true,"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth016WebAuthUserAgentP5startyyF"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthuseragent\/start()"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","title":"Auth0","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"()"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","url":"\/documentation\/auth0\/webauthuseragent\/start()","type":"topic","abstract":[{"text":"Starts the external user agent.","type":"text"}],"required":true,"kind":"symbol","title":"start()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol","title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Starts the external user agent."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"title":"start()","required":true,"roleHeading":"Instance Method","externalID":"s:5Auth016WebAuthUserAgentP5startyyF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"()"}],"symbolKind":"method","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthuseragent\/start()"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"()","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"title":"start()","required":true,"abstract":[{"text":"Starts the external user agent.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"()","kind":"text"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/index/availability.index b/docs/index/availability.index index 221a9bed..019faccf 100644 Binary files a/docs/index/availability.index and b/docs/index/availability.index differ diff --git a/docs/index/data.mdb b/docs/index/data.mdb index 41c66933..b9a0d9ea 100755 Binary files a/docs/index/data.mdb and b/docs/index/data.mdb differ diff --git a/docs/index/index.json b/docs/index/index.json index bde3b1d8..3f5a7c2b 100644 --- a/docs/index/index.json +++ b/docs/index/index.json @@ -1 +1 @@ -{"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"},{"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"},{"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\/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 d33f4489..911bd254 100644 Binary files a/docs/index/navigator.index and b/docs/index/navigator.index differ diff --git a/docs/metadata.json b/docs/metadata.json index 16e6e8d5..e3983ff8 100644 --- a/docs/metadata.json +++ b/docs/metadata.json @@ -1 +1 @@ -{"bundleIdentifier":"com.auth0.Auth0","schemaVersion":{"major":0,"patch":0,"minor":1},"bundleDisplayName":"Auth0"} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":1,"major":0},"bundleDisplayName":"Auth0","bundleIdentifier":"com.auth0.Auth0"} \ No newline at end of file